使用Rails和HTTParty将JSON发布到API


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提交此内容吗?任何帮助是极大的赞赏。我喜欢这里的社区。

Answers:


257

我通过添加.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”)对于“ Accept”标头也很有意义。因此标题应该是:headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'}。注意:标头不应转换为JSON,应该是哈希值
-Devaroop

我部署了一个Rails引擎(打包为gem),对调试Rails上的API确实很有用。您只需要安装引擎并转到您指定的URL,即“ localhost:3000 / api_explorer”即可查看它。这也是记录API的一种方式,可以从文件中读取Web服务规范。该gem名为“ api_explorer”,该存储库为github.com/toptierlabs/api_explorer,欢迎提出任何评论或帮助改善api。:)
Tony

6
愚蠢的是没有在文档中。
Tyler Collier 2014年

谢谢!这很棒!但是,问题是:如何包含JSON数组?
鲁宾·马丁内斯(Ruben Martinez)

1
想要像上述格式一样推送90k记录之类的收集数据。我可以在单个API调用中推送整个数据吗?请让我知道您的评论
Raju akula 2015年

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/...
Fryie

它也可能是必要的设置内容类型报头:ruby-doc.org/gems/docs/h/httparty2-0.7.10/HTTParty/...
Fryie

1
query_string_normalizer应该用于查询字符串,而不是发布数据。
josephrider

链接ruby-doc.org已死,文档位于httparty doc
yacc
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.