質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.34%

  • Ruby

    8191questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

  • Ruby on Rails

    7671questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

  • HTTPヘッダー

    95questions

    Hypertext Transfer Protocol(HTTP)の中のHTTPヘッダフィールドはHTTPの要求やレスポンスの機能しているパラメーターが含まれます。その要求もしくはレスポンスライン(メッセージの最初の一行)でメッセージヘッダを作ります。

  • HttpWebRequest

    55questions

    HttpWebRequestとは.NETにおけるクラスであり、WebRequestクラスをHTTPに導入するものです。

リクエストヘッダとパラメータを付与してPOSTでAPIにアクセスしたい(gem/httpclientを使用)

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 653

kotahayashi

score 6

 前提・実現したいこと

Rubyのgem・httpclientを使用して、タイトルの通り、
リクエストヘッダとパラメータを追加した上でAPIにPOSTメソッドでアクセスしたいと考えています。

なお、他のgemを使用する等により確実に実行できる方法がございましたら、そちらでも構いません。

 つまずいている箇所

httpclientのライブラリを参照しましたが解説が不十分で、どのメソッドをどのように使用すれば良いかわかりませんでした。
https://github.com/nahi/httpclient

 該当のソースコード

  URL = 略
  USER = 略
  PASSWORD = 略

  def get_hoge
    c = HTTPClient.new()
    c.set_auth(URL, USER, PASSWORD)
    res = c.post_content(URL, {
      'HOGE' => "FUGA"
    })
    res
  end

リクエストヘッダのフィールド名:HOGE、値:FUGA に加えて、
パラメータとして hoge: fuga を付与してアクセスしたいと考えています。

 試したこと

上記の通りpost_contentメソッドを使用してみましたが、
リクエストヘッダとパラメータを同時に記述する方法が分かりませんでした。

 補足情報(FW/ツールのバージョンなど)

Railsのバージョン:5.2.0
httpclientのバージョン:2.8.3

よろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

ドキュメントをきちんと読んでいないだけのように思えます。
内容はこれで十分でしょう。

https://github.com/nahi/httpclient には、
「See HTTPClient for documentation.」と書かれており、
ドキュメントへのリンクがあります。

例えば、HttpCliene#post_contentメソッドのドキュメントを見れば、
パラメータ(body)とヘッダ(header)の指定方法は明らかです。
https://www.rubydoc.info/gems/httpclient/HTTPClient#post_content-instance_method

 body, headerを指定する例

client = HTTPClient.new
uri = 'http://...'
params = {
  a: 1,
  b: 2
}
headers = {
  'User-Agent' => 'Sample/RubyClient/1.0'
}
content = client.post_content(uri, body: params, header: headers)

 postメソッドの例

client = HTTPClient.new
uri = 'http://...'
params = {
  a: 1,
  b: 2
}
headers = {
  'User-Agent' => 'Sample/RubyClient/1.0'
}
# postの戻り値はHTTP::Messageのインスタンス
response = client.post(uri, body: params, header: headers)

response.body => レスポンスボディ文字列
response.status => HTTPステータス(200,400などの数値)
response.headers => レスポンスヘッダのHash

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/07/10 14:23

    ご回答くださりありがとうございます。
    私が初心者である旨と、以下の旨を記述するべきでした。質問に不備があり申し訳ございません。

    当然こちらのドキュメントを参照した上で、post_contentメソッドが使えるのではないかという判断に至りました。
    しかし、bodyとheaderの記述方法が同じように見え、どのような形で併記すればそれぞれbody, headerとしてカスタムできるのか分かりませんでした。再度思案しましたが、まだ見当がつきません。

    私の判断に自信がなかったことと、回答率をあげる等の点から抽象度を高めて質問をしましたが、このような形となりお手数をおかけしました。

    キャンセル

  • 2018/07/10 15:32 編集

    今回の件では、post_contentのドキュメントURLを質問に明記して、内容が理解できないという事を簡潔に書いたほうが回答してもらいやすいと思います。
    整理すると、post_contentのドキュメントにあるbody, headerの指定方法が分からないという事のようですので、回答にて例を示します。

    なお、post_contentではresponse bodyだけを取得するメソッドなので汎用性が低いので、実用するならばpostを使うべきかなと思います。

    キャンセル

  • 2018/07/13 18:11

    別の部分にミスがあり検証に時間がかかってしまいましたが、お示しいただいたコードの書き方でアクセスできました。
    質問のしかたについてもアドバイスいただき、ありがとうございました。

    キャンセル

同じタグがついた質問を見る

  • Ruby

    8191questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

  • Ruby on Rails

    7671questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

  • HTTPヘッダー

    95questions

    Hypertext Transfer Protocol(HTTP)の中のHTTPヘッダフィールドはHTTPの要求やレスポンスの機能しているパラメーターが含まれます。その要求もしくはレスポンスライン(メッセージの最初の一行)でメッセージヘッダを作ります。

  • HttpWebRequest

    55questions

    HttpWebRequestとは.NETにおけるクラスであり、WebRequestクラスをHTTPに導入するものです。

  • トップ
  • Rubyに関する質問
  • リクエストヘッダとパラメータを付与してPOSTでAPIにアクセスしたい(gem/httpclientを使用)