記事情報殿堂入り

翻訳: WebAPI 設計のベストプラクティス

翻訳: WebAPI 設計のベストプラクティス

これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣...

更新日: 2016-07-19
記事の見出し
  • 翻訳: WebAPI 設計のベストプラクティス
  • まえがき
  • API 設計の勘所
  • RESTful な URL にしよう
  • いつ何時も、SSL 通信を使おう
  • かっこいい仕様書を作ろう
  • バージョンは URL に含めよう
  • フィルタ・ソート・検索はリクエストパラメータでやろう
  • レスポンスのフィールドを絞れるようにしよう
  • 作成・更新の後は変更後の情報をフルで返そう
  • HATEOAS を採用するのは待とう
  • 可能な限り JSON で返そう
  • フィールドの命名規則を考えよう
  • JSON はデフォルトで整形しよう
  • 要素はラップせずに返そう
  • 追加・更新時のリクエストボディには JSON を使おう
  • ページング情報はレスポンスヘッダに入れよう
  • 関連データを埋め込む手段を作ろう
  • HTTP メソッドを上書きしよう
  • リクエスト制限情報はレスポンスヘッダに入れよう
  • トークン認証を使おう
  • キャッシュの情報をレスポンスヘッダに入れよう
  • ちゃんとしたエラーメッセージを返そう
  • HTTP ステータスコードを有効活用しよう
  • まとめ
  • 追記(2016/03/29)
  • 追記(2016/07/19)
テックブログ情報
翻訳: WebAPI 設計のベストプラクティス
ブログ株式会社KUFU - Qiita
ブログ概要テクノロジーとKUFUで社会構造をハックする
QiitaQiita::kufuinc
会社名株式会社KUFU
会社概要