POST JSON в API с использованием Rails и HTTParty

106

Я хотел бы, чтобы пользователь моего приложения ruby ​​on rails мог отправлять тикеты в мою внешнюю систему управления тикетами, squishlist.com. У них есть api и следующие инструкции. Вам необходимо пройти аутентификацию и получить токен, а затем отправить билет с токеном. Из squishlist.

# get the token

https://api.squishlist.com/auth/?cfg=testcorp&user_key=privatekey&api_key=TEST-KEY-12345
  => {"token": "authtoken",
      "expires": "2010-06-16 13:31:56"}

# and then the ticket with the token

https://api.squishlist.com/rest/?cfg=testcorp&token=authtoken&method=squish.issue.submit&prj=demo
  POST data: {'issue_type': 1, 'subject': 'Hello, world.', 4: 'Open', 5: 10}

В целях тестирования я создал контроллер, маршрут и представление (страницу) для тестирования. На моем контроллере у меня есть следующие

require 'httparty'
require 'json'

class SubmitticketController < ApplicationController

    def submit_a_ticket

        @cfg = 'xxxsupport'
        @user_key = '4787fsdbbfbfsdbhbfad5aba91129a3f1ed1b743321f7b'
        @api_key = 'MrUser411'
        @project = 'excelm-manoke'
        @url_new_string = 'https://api.squishlist.com/auth/?cfg='+@cfg+'&user_key='+@user_key+'&api_key='+@api_key
        # https://api.squishlist.com/auth/?cfg=xxxsupport&user_key=4787fsdbbfbfsdbhbfad5aba91129a3f1ed1b743321f7b&api_key=MrUser411  - this is what is created by @url_new_string
        response =  HTTParty.get(@url_new_string.to_str)  #submit the string to get the token
        @parsed_and_a_hash = JSON.parse(response)
        @token = @parsed_and_a_hash["token"]


        #make a new string with the token

        @urlstring_to_post = 'https://api.squishlist.com/rest/?cfg='+@cfg+'&token='+@token+'&method=squish.issue.submit&prj='+@project

        #submit and get a result

        @result = HTTParty.post(@urlstring_to_post.to_str, :body => {:subject => 'This is the screen name', :issue_type => 'Application Problem', :status => 'Open', :priority => 'Normal', :description => 'This is the description for the problem'})

    end

end

А затем у меня есть страница, на которую я перехожу, чтобы увидеть результат действий контроллеров, и на ней есть следующий код.

<p><%= @result %></p>

Я знаю, что в целом это работает, из-за ответов, которые я получил в процессе. Мой json отличается от примера из-за полей, которые я определил в squishlist. Может ли кто-нибудь помочь мне в этом вопросе?

Я предполагаю, что настоящая проблема в том, что я не могу понять, как выглядит json, и действительно ли он похож. Я действительно не очень разбираюсь в json. Должен ли я использовать что-нибудь, что может быть легко. Должен ли я использовать ajax для отправки этого. Любая помощь приветствуется. Мне нравится здесь сообщество.

Гомер Джон
источник

Ответы:

258

Я решил это, добавив .to_jsonинформацию о заголовке

@result = HTTParty.post(@urlstring_to_post.to_str, 
    :body => { :subject => 'This is the screen name', 
               :issue_type => 'Application Problem', 
               :status => 'Open', 
               :priority => 'Normal', 
               :description => 'This is the description for the problem'
             }.to_json,
    :headers => { 'Content-Type' => 'application/json' } )
Гомер Джон
источник
9
Кроме того, некоторые API, такие как «GitLab API», чувствительны к заголовку «Принять». Так что заголовок должен быть :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'}. Примечание: заголовок не следует преобразовывать в JSON, ожидается, что это будет хэш
Devaroop
Я развернул движок Rails (упакованный как драгоценный камень), который действительно полезен для отладки API на рельсах. Вам просто нужно смонтировать движок и перейти по указанному вами URL, то есть «localhost: 3000 / api_explorer», чтобы увидеть его. Это также способ документировать API, считывая спецификацию веб-сервисов из файла. Камень называется api_explorer, а репозиторий - github.com/toptierlabs/api_explorer. Любые комментарии или помощь в улучшении api приветствуются. :)
Тони
6
Просто глупо, что этого нет в документации.
Тайлер Кольер,
Спасибо! Это отлично сработало! Однако вопрос: как бы вы включили массив JSON?
Рубен Мартинес-младший,
1
Хотите отправить данные коллекции, например, 90 тыс. Записей, как в приведенном выше формате. Могу ли я передать все данные за один вызов API? пожалуйста, дайте мне знать ваши комментарии
Раджу Акула
14

:query_string_normalizerОпция также доступна, который перепишет нормализатор по умолчаниюHashConversions.to_params(query)

query_string_normalizer: ->(query){query.to_json}
Брайан Макнабб
источник
Потрясающие! Это позволяет хранить хеш, request.options[:body]но отправлять правильную строку. Это должен быть настоящий ответ на вопрос.
Freemanoid
Опцию также можно установить по умолчанию в классе, включая HTTParty, с помощью метода класса query_string_normalizer, см .: ruby-doc.org/gems/docs/h/httparty2-0.7.10/HTTParty/…
Фрай,
Также может потребоваться установить заголовок типа контента: ruby-doc.org/gems/docs/h/httparty2-0.7.10/HTTParty/…
Фрай,
1
query_string_normalizerследует использовать для строк запроса, а не для данных публикации.
josephrider
Ссылки на ruby-doc.orgмертвы, документация находится на httparty doc
yacc