Postman を使い倒す

• APIの開発がむちゃくちゃ捗る「Postman」の使い方
  • test collection　というのが良い。次に実行するリクエストを指定できるのは初めて知った。
    • post scriptに postman.setNextRequest("次のリクエストの名前"); と追加してやると、次のリクエストを明示できる。 collection run がより便利になりそうな予感。 (create -> read -> delete の試験とかね)

Document

• view in web を押すとでる。
• しかも言語ごとのリクエストのプログラム例が出力される。
• response 例は Example を postman で登録すると出る。

Example

• リクエスト毎に複数指定できる
  • 正常応答、異常応答並べたいんだけど、複数登録した example が上手く mock や document で機能していないなぁ…
    • documentation では上手く機能していた！
    • mock は反映に時間がかかっているっぽい！？しばらくしたら結局動いた。

mock

• example に沿って response を返してくれるからいい感じ。 参考: Mocking with examples
• 注意点
  • x-api-key は mock を private にする時に header に付与必要なもので、 postman の web page から生成が必要。自作で x-api-key を使った認証系を擬似する時にちょっと勝手が違って躓くかも。
  • 複数の example が登録されている時の選択アルゴリズム: method, url, header, response code でマッチングする. 詳細は Matching algorithm 参照. POST/PUT する body の差だけで response の変化を期待すると, 動かないよ. (本来不要な queryparam をつけたりして差をつけるしか無いか)

postman 以外の node.js 系 REST API mock

• mocky というのもあるが、最も人気なのは JSON Server っぽい
• JSON Server: たった30秒でREST APIのモックが作れる JSON Serverでフロントエンド開発が捗る
• ほかのwebツールとしては requestbin なんてのもあるね。

料金、プラン比較

こちら

おまけ: REST APIの設計

• http status code と利用シーン