Ruby отправить запрос JSON

86

Как отправить запрос JSON в рубине? У меня есть объект JSON, но я не думаю, что смогу это сделать .send. Должен ли я использовать javascript для отправки формы?

Или я могу использовать класс net / http в ruby?

С заголовком - тип содержимого = json и тело объекта json?

Энди
источник

Ответы:

76
uri = URI('https://myapp.com/api/v1/resource')
req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
req.body = {param1: 'some value', param2: 'some other value'}.to_json
res = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(req)
end
CarelZA
источник
8
Мне нравится ваше предложение использовать URI для обработки имени хоста и порта, что в противном случае довольно утомительно. Но вы забыли установить uri.path в Post.new (...):req = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
ArnauOrriols
1
Самый простой и чистый ответ. Это круто.
Joelc
http.request(req).read_bodyпрочитать тело ответа. Большой!
iGian
1
Я почти уверен, что это изменилось в 2.4.1, но боже мой. Этот синтаксис груб. Он знает, что у него есть URI из Post.new (), так зачем вам заново передавать значения, разделяя их в start (). Валовой. Неудивительно, что в Ruby так много других пакетов, связанных с http.
Рамбатино 02
50
require 'net/http'
require 'json'

def create_agent
    uri = URI('http://api.nsa.gov:1337/agent')
    http = Net::HTTP.new(uri.host, uri.port)
    req = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
    req.body = {name: 'John Doe', role: 'agent'}.to_json
    res = http.request(req)
    puts "response #{res.body}"
rescue => e
    puts "failed #{e}"
end
неоней
источник
Какое исключение следует указать
Mio
7
Для запросов https просто добавьте: http.use_ssl = true.
Skill M2
17

Я думаю, что HTTParty упрощает это (и работает с вложенными json и т.д., которые, похоже, не работали в других примерах, которые я видел.

require 'httparty'
HTTParty.post("http://localhost:3000/api/v1/users", body: {user: {email: 'user1@example.com', password: 'secret'}}).body
Брайан Армстронг
источник
6

пример из реальной жизни, уведомить Airbrake API о новом развертывании через NetHttps

require 'uri'
require 'net/https'
require 'json'

class MakeHttpsRequest
  def call(url, hash_json)
    uri = URI.parse(url)
    req = Net::HTTP::Post.new(uri.to_s)
    req.body = hash_json.to_json
    req['Content-Type'] = 'application/json'
    # ... set more request headers 

    response = https(uri).request(req)

    response.body
  end

  private

  def https(uri)
    Net::HTTP.new(uri.host, uri.port).tap do |http|
      http.use_ssl = true
      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    end
  end
end

project_id = 'yyyyyy'
project_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
url = "https://airbrake.io/api/v4/projects/#{project_id}/deploys?key=#{project_key}"
body_hash = {
  "environment":"production",
  "username":"tomas",
  "repository":"https://github.com/equivalent/scrapbook2",
  "revision":"live-20160905_0001",
  "version":"v2.0"
}

puts MakeHttpsRequest.new.call(url, body_hash)

Примечания:

если вы выполняете аутентификацию через заголовок набора заголовков авторизации req['Authorization'] = "Token xxxxxxxxxxxx" или http://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token.html

эквивалент8
источник
... но, честно говоря, это круто, но в реальной жизни я бы просто использовал HTTParty stackoverflow.com/a/14491995/473040 :) ... особенно если вы имеете дело с обработкой https
эквивалентно 8
требовать uri бесполезно, так как он уже требуется net / http
noraj
@exexample8: «в реальной жизни я бы просто использовал HTTParty» - то есть, если вы не создаете бережливую жемчужину или иным образом не хотите другую зависимость. :)
Серджио Тюленцев 07
@SergioTulentsev согласен ... если вы не создаете gem / lib (или микросервис на основе Ruby), где вы не хотите вводить ненужные зависимости;)
эквивалент8
4

Простой пример запроса JSON POST для тех, кому он нужен, даже проще, чем то, на что Том ссылается:

require 'net/http'

uri = URI.parse("http://www.example.com/search.json")
response = Net::HTTP.post_form(uri, {"search" => "Berlin"})
Christoffer
источник
19
Похоже, это должно работать, но post_form переводит параметры в синтаксис? Key = value & key = value. Если вы хотите выполнить POST с телом запроса, установленным в строку JSON, я думаю, вам нужно другое решение.
Бен Готоу
Это не работает с глубоко вложенным json. Все, что выходит за пределы первого уровня, становится строкой.
neoneye
Не просто так выглядит. Оно работает. Это просто конечно. но для простых вещей, таких как пример, который я привел, он отлично работает
Christoffer
4
По сути, это не запрос JSON. Это тело с URL-кодом. Нет JSON. Об этом и сказано в заголовке. Это не работает ни с одним примером.
raylu
4
Это неверный ответ. Это POST в mime / multipart на URL-адрес, в котором написано "json".
Джон Хогеланд
4

Это 2020 год - никто не должен Net::HTTPбольше использовать, и все ответы, похоже, говорят об этом, используйте гем более высокого уровня, такой как Faraday - Github


Тем не менее, то, что мне нравится делать, - это оболочка вокруг вызова HTTP api, что-то вроде

rv = Transporter::FaradayHttp[url, options]

потому что это позволяет мне подделывать HTTP-вызовы без дополнительных зависимостей, то есть:

  if InfoSig.env?(:test) && !(url.to_s =~ /localhost/)
    response_body = FakerForTests[url: url, options: options]

  else
    conn = Faraday::Connection.new url, connection_options

Там , где обманщик выглядит как эта

Я знаю, что существуют фреймворки имитации / заглушки HTTP, но, по крайней мере, когда я исследовал в прошлый раз, они не позволяли мне эффективно проверять запросы, и они были только для HTTP, а не, например, для необработанных обменов TCP, эта система позволяет мне иметь единая структура для всего API-взаимодействия.


Предполагая, что вы просто хотите быстро и грязно преобразовать хэш в json, отправьте json на удаленный хост, чтобы протестировать API и проанализировать ответ на ruby, это, вероятно, самый быстрый способ без использования дополнительных драгоценных камней:

JSON.load `curl -H 'Content-Type:application/json' -H 'Accept:application/json' -X POST localhost:3000/simple_api -d '#{message.to_json}'`

Надеюсь, это само собой разумеется, но не используйте это в производстве.

bbozo
источник
2
Лол, почему все ненавистники? :) В сообщении четко говорится, что он не предназначен для производства или какой-либо другой серьезной цели, но это самый быстрый способ настроить вызов JSON api, чтобы увидеть, как ведет себя служба
bbozo
Вы не можете сделать это с помощью проверки подлинности NTLM. Таким образом, Net :: HTTP по-прежнему является единственным, у которого есть поддерживающая его библиотека.
Руан
1
Не согласен с утверждением «никто не должен использовать Net::HTTP»
JellicleCat
nobody should be using Net::HTTP any moreПроголосовали против из-за @bbozo
Патрисио Сард
3

Это работает на Ruby 2.4 HTTPS Post с записанным объектом JSON и текстом ответа.

require 'net/http' #net/https does not have to be required anymore
require 'json'
require 'uri'

uri = URI('https://your.secure-url.com')
Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
  request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
  request.body = {parameter: 'value'}.to_json
  response = http.request request # Net::HTTPResponse object
  puts "response #{response.body}"
end
Сабче
источник
2

Мне нравится этот легкий клиент HTTP-запросов под названием unirest

gem install unirest

Применение:

response = Unirest.post "http://httpbin.org/post", 
                        headers:{ "Accept" => "application/json" }, 
                        parameters:{ :age => 23, :foo => "bar" }

response.code # Status code
response.headers # Response headers
response.body # Parsed body
response.raw_body # Unparsed body
Тохи
источник
1

API net / http может быть трудным в использовании.

require "net/http"

uri = URI.parse(uri)

Net::HTTP.new(uri.host, uri.port).start do |client|
  request                 = Net::HTTP::Post.new(uri.path)
  request.body            = "{}"
  request["Content-Type"] = "application/json"
  client.request(request)
end
Мориарти
источник
Этот код не работает. Вам нужно инициализировать Net :: HTTP с помощью #start следующим образом:Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |client|
Тайлер
Работает с ruby ​​2.3.7p456 (28.03.2018, ревизия 63024) [universal.x86_64-darwin18]
Мориарти
0
data = {a: {b: [1, 2]}}.to_json
uri = URI 'https://myapp.com/api/v1/resource'
https = Net::HTTP.new uri.host, uri.port
https.use_ssl = true
https.post2 uri.path, data, 'Content-Type' => 'application/json'
Фил Пирожков
источник