Web APIの設計指針についての補足｜デロイト トーマツ ウェブサービス株式会社（DWS）公式ブログ
先日初めて、自分が書いたブログの記事、Web API設計指針を考えたがはてブでバズるという経験をしました。たくさんの方に読んでいただけたというのは非常にうれしいことです。ただ、設計指針には根拠を書かなかった箇所が多く補足したいところが出てきたため、以下の内容について根拠などを書いていきたいと思います。 バージョニングについて RESTfulについて バージョニングの設計・実装について 以下の指針を書きました。 APIにはバージョンをつける。 vと整数のバージョン番号をURLにつける。 バージョンは整数。マイナーバージョンは作らない。 例） http://api.example.com/v1/users 上記指針をRailsで実装する場合には、バージョンを上げるときにはコントローラごと分けるようにしています。 ただ、少々前の話になりますが、こんな記事がありました。 APIのバージョニングは限
RESTful API の設計のキホン
2016/10/12 社内勉強会で使ったスライドを社外向けに一部加筆訂正したもの
翻訳: WebAPI 設計のベストプラクティス - Qiita
これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。 今後 WebAPI を設計される方は、是非参考にしてみてください。 なお、誤訳がありましたら編集リクエストを頂けると幸いです。 まえがき アプリケーションの開発が進むにつれて、その WebAPI を公
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - microsoft/api-guidelines: Microsoft REST API Guidelines
Web API Design - 開発者が愛するインターフェイスを作る
