APIを作る際のAPIバージョンに関するメモ - kurobaraのブログ
はじめに APIを作るときにどうするか？を開発チーム内で議論したので、備忘録的なメモ 発端となった会話は、こんな感じだったはず 「マイクロアーキテクチャなサービスを作ったときってAPIを作ると思うけど、ライフサイクルって考えてる？」 「APIを利用するフロントは更新できるけど、APIは依存されるものが多いから簡単には更新できないよね？」 「APIってモバイルアプリからも利用した場合、修正しづらくない？バージョン管理でもするの？」 APIの種別 以下の３つぐらいになりそう 外部公開向け モバイルアプリ向け webサービス向け 外部公開向け API変更の影響が大きい ドキュメント更新必須 利用者が離れるのでドラスティックな変更はできない 利用者への周知が必須 モバイルアプリ向け アプリのみが影響を受けるので、API変更における影響は少ない アプリバージョンによるので自由にAPI更新ができない
翻訳: 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ページを開く
