โพสต์ JSON เป็น API โดยใช้ Rails และ HTTParty


106

ฉันต้องการให้ผู้ใช้ภายในแอป Ruby on rail สามารถส่งตั๋วไปยังระบบจัดการตั๋วภายนอกของฉัน 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' และ repo คือgithub.com/toptierlabs/api_explorerยินดีต้อนรับความคิดเห็นใด ๆ หรือความช่วยเหลือในการปรับปรุง API :)
Tony

6
มันเป็นเรื่องงี่เง่าที่ไม่ได้อยู่ในเอกสาร
Tyler Collier

ขอบคุณ! มันใช้งานได้ดี! คำถาม: คุณจะรวมอาร์เรย์ JSON ได้อย่างไร
Ruben Martinez Jr.

1
ต้องการผลักดันข้อมูลการรวบรวมเช่นระเบียน 90k เหมือนในรูปแบบด้านบน ฉันสามารถพุชข้อมูลทั้งหมดในการเรียก API ครั้งเดียวได้หรือไม่ โปรดแจ้งให้เราทราบความคิดเห็นของคุณ
Raju akula

14

:query_string_normalizerตัวเลือกยังมีอยู่ซึ่งจะแทนที่ 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
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.