cURLからRubyへ
curlコマンドを貼り付けると、標準ライブラリのnet/httpを使った、そのまま動くRubyスクリプトが得られます。gemは要りません。
変換はすべてブラウザ内で行われます。トークンや資格情報を含むコマンドがアップロードされることはありません。
開発・運営:Udit Agarwal
curlをPythonに変換する
cURLからRubyへ について
APIのドキュメントはcurlで書かれ、アプリケーションはRubyで書かれるので、同じ翻訳作業が手作業で何度も繰り返されます。この変換ツールは重要なフラグ、つまりメソッド、ヘッダー、データ、Basic認証、-Gによるクエリの扱いを解析し、net/httpを使ったスクリプトを出力します。net/httpはRubyに同梱されているので、gemを入れる必要はありません。JSONボディは中身の見えない文字列として貼り込むのではなく、ハッシュとして書き出してJSON.generateに渡すので、実行前に編集しやすくなります。-uフラグは手書きのAuthorizationヘッダーではなくbasic_authの呼び出しになります。Rubyの開発者が自分で書いたと思えるコードに仕上がります。
機能
- 標準ライブラリのnet/httpを使うので、インストールは不要
- ヘッダー、リクエストボディ、クエリ文字列、Basic認証をすべて引き継ぎ
- JSONボディは編集できるRubyのハッシュとして出力
- 手組みのAuthorizationヘッダーではなくbasic_authを使用
- 標準外のメソッドはNet::HTTPGenericRequestで対応
- httpsのURLでは自動でTLSを有効化
- Rubyに対応するものがないcurlのフラグを警告
- 結果を.rbファイルとしてダウンロード
- 変換はすべてブラウザ内で完結
cURLからRubyへ の使い方
- APIドキュメントからcurlコマンドをコピーします
- 左側の欄に貼り付けます
- 右側に生成されたRubyのコードを確認します
- コピーするか、.rbファイルとしてダウンロードします
例
入力
curl -X POST https://api.example.com/users -H "Content-Type: application/json" -d '{"name":"Ada"}'
出力
request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = JSON.generate({ "name" => "Ada" })
ボディは引用符で囲んだ塊ではなく、編集できるハッシュとして出力されます。
よくあるエラーとトラブルシューティング
- スクリプトがSSL検証エラーを出す。 — たいていは自己署名証明書か社内の証明書が原因です。検証を無効にするのではなく、OpenSSLにCAバンドルの場所を指定してください。curlの-kフラグには安全な対応物がないため、意図的に変換していません。
- APIがリクエストボディを受け付けない。 — Content-Typeヘッダーがコピーの過程で失われていないか確認してください。net/httpは自動では設定しないため、ヘッダーなしで送ったJSONはサーバー側でフォームデータとして解析されることがよくあります。
- リダイレクトが追跡されない。 — curlの-Lに直接対応するものはありません。net/httpは3xxの応答をそのまま返し、判断を呼び出し側に委ねます。必要ならNet::HTTPRedirectionかどうかを確認し、Locationヘッダーの宛先に改めてリクエストしてください。
よくある質問
- 生成されたRubyのコードにgemは必要ですか。
- 必要ありません。net/http、uri、jsonはすべてRubyに同梱されているので、標準のインストールのまま、何も追加せずに動きます。
- FaradayやHTTPartyではなくnet/httpを使うのはなぜですか。
- 標準ライブラリのコードはGemfileなしでどこでも動くので、よく知らないプロジェクトに貼り込むコード片としては最も安全な選択です。あとからgemに移すのも簡単で、ヘッダーとボディはすでに分けて書かれています。
- RubyのコードでBasic認証はどう扱われますか。
- -uフラグは、ユーザー名とパスワードを別々の引数に取るrequest.basic_authの呼び出しになります。これが慣用的な書き方で、手組みのAuthorizationヘッダーに必要なBase64エンコードの手順も省けます。
- 珍しいHTTPメソッドはRubyでどう出力されますか。
- PURGEのようにNet::HTTPのクラスがないメソッドは、メソッド名を文字列で指定したNet::HTTPGenericRequestとして出力されます。サーバーが受け付けるものなら何でも扱えます。
- Rubyに変換するcurlコマンドは外部に送信されますか。
- されません。解析もコード生成もブラウザ内で行われるので、有効なAPIトークンを含むコマンドでもマシンの外へ出ることはありません。
関連ツール
API ツールの他のツール
API ツールのツールをすべて見る (24) · すべてのツール