WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita

WebAPIの仕様を記述する方法はいくつかあると思う。 普通に日本語で記述する JSON Hyper-Schema、WADL、RAML、Swaggerなどを使う 仕様書の代わりにプログラムを書く HTTPメッセージそのものを記述しておく でも、文法にばらつきがあったり、読みにくかったり、ツールのセットアップが面倒だったり、どれもイマイチな所があって、手軽な方法が欲しいと思っていた。 何気なくcurlコマンドのオプションを調べていたら、「もうこれでAPIドキュメント扱いにしちゃえばいいんじゃね？」と思えてきたのでメモしておく。 curlコマンドのおさらい curlコマンドはlibcurlの付属コマンドで、最近のUnix系OSなら大抵最初から入っていると思う。コマンドの詳細はmanを読んでいただければ。 cURL - How To Use （マニュアルページ日本語訳） curlコマンドのオプシ

[sho]

exampleとspecificationの違いがないWeb業界の闇 (コピペすればすぐ試せるcurlのexampleを書いておくのは良い習慣だと思う)

[Jxck]

Chrome のネットワークタブで copy as curl が超絶便利なんだけど、条件付きでいいから paste as curl でリクエストできたらと思うのは俺だけだろうか。

[jakalada]

IRKitがAPIの説明でcurl使ってて良いと思ってた。仕様書の記述が飲み込めないときに試すまでの道のりが短いと助かる

[quabbin]

昔はCURLで検索すると、プログラミング言語のCURLの話ばかり引っかかって調べにくい状況だったから、使うのが億劫になりがちだったんだけど…最近は言語のCURLなんてどこに行ったんだろう状態で、非常に嬉しい

[aki03]

レスポンス仕様をどうするか、かなぁ

[t-wada]

面白い。すぐ試せる、実行可能なドキュメントという側面はとても良いと思う

[syonx]

Feedlyの例もcurlですね http://developer.feedly.com/

[twoterabytes]

本論とは関係ないけど、PowerShellで動くサンプルももう少し流行ってもいいと思うんだ

[a-know]

レスポンス仕様もいいのないかなぁ

[bunnyhop]

これをドキュメント代わりにするの流石に辛いのでは

[satmat]

“$ curl 'http://example.com/entries' \ --verbose \ --request POST \ --header 'Content-Type: application/json' \ --data-binary '{"title":"hoge","description":"fuga"}'”

[tmsanrinsha]

[etc/hosts][conf]

[tana_bata]

“ ”

[himejimasandesu]

linux

[digo]

イイ

[igrep]

ブクマしてなかった。

[kazutaka83]

CurlでAPI叩くのはわかりやすくて良いっすね。

[moty0815]

WebAPIリクエスト仕様書としてcurlコマンドのご提案

[androidzaurus]

カールおじさん。

[Dai_Kamijo]

面白い。すぐ試せる、実行可能なドキュメントという側面はとても良いと思う / “WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita” — Takuto Wada (@t_wada) May 26, 2015 from Twitter https://twitter.com/Dai_Kamijo May 26, 2015 at 03:46PM via

[tyru]

--libcurlオプション知らなかった

[coburn69]

“REPL”

[yosu1]

すばらしー！

[Kwappa]

知見だー。

[zetamatta]

mjd? 「--libcurlオプションを付けると、それと同じことを行うC言語のソースコードを出力してくれる」

[dyamashiro]

とてもいい…

[hatajoe]

confなんてあるのか知らんかった！これは良さそうやなー。

[koheisg]

例えばAPIを提供するサービスで、顧客から何かBAD REQUESTなんだけどみたいなメールを見た時にcurlで繋がるか確認してください。みたいな返信をするたびに、仕様書に貼っとけばいいんじゃないかとは思う。

[june29]

カールおじさん

[kwms]

--resolv知らなかった

[peccu]

libcurlオプションすごい / WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita

[u1tnk]

誰でも動くから良いですなぁ。

[mawatarin]

WebAPIのリクエストの仕様兼サンプルをcURLで書くのはどうかという提案。

[efcl]

Curlでドキュメント。 httpieの方が見た目は好きだな

[HHR]

--header 'Content-Type: application/json' \ --data-binary @example.json

[papiro]

curlコマンドでWebAPIアクセスの仕様を考える。正にシェル芸向き・・・--lib-curlオプションなんてのがあるのか。C言語のソースコードを吐き出す。

[nazoking]

うーん json のプロパティーとかが問題だったりするからな……

[hidesuke]

俺のcurl力低すぎて辛い