元々Qiitaに投稿していたものをZennに移行しました。 最初の公開日は2016-01-03のため古い内容を含みます。 ご了承の上ご利用ください。 概要 初心者ながらもAPIを設計する機会があり、 有名どころをパクれば参考にすればいい設計になりそうな気がするので、 まとめておきます 今回の話の範囲 REST 今回はこちらを読んでREST APIを設計することにしたので、 RESTのみ扱います 詳細説明について 各APIの詳細な説明は今回の趣旨に反するので省きます API設計のポイントはこちらの記事がわかりやすいと感じたので、 参考にします エラーについて エラーの比較を行っている記事もあり、 すごく参考になっているのでリンクしておきます 「WebAPIでエラーをどう表現すべき?15のサービスを調査してみた」 実際のAPI例 間違っていたり、更新されたり、足りなかったりした場合はお知らせ下
![REST API設計者のための有名APIのURL例](https://cdn-ak-scissors.b.st-hatena.com/image/square/532cdf2b616fce63357cec74b356d3f69891894c/height=288;version=1;width=512/https%3A%2F%2Fres.cloudinary.com%2Fzenn%2Fimage%2Fupload%2Fs--BGhz94HA--%2Fc_fit%252Cg_north_west%252Cl_text%3Anotosansjp-medium.otf_55%3AREST%252520API%2525E8%2525A8%2525AD%2525E8%2525A8%252588%2525E8%252580%252585%2525E3%252581%2525AE%2525E3%252581%25259F%2525E3%252582%252581%2525E3%252581%2525AE%2525E6%25259C%252589%2525E5%252590%25258DAPI%2525E3%252581%2525AEURL%2525E4%2525BE%25258B%252Cw_1010%252Cx_90%252Cy_100%2Fg_south_west%252Cl_text%3Anotosansjp-medium.otf_37%3Ayu1ro%252Cx_203%252Cy_121%2Fg_south_west%252Ch_90%252Cl_fetch%3AaHR0cHM6Ly9saDMuZ29vZ2xldXNlcmNvbnRlbnQuY29tL2EtL0FPaDE0R2l0SFFCdkhGY1RjdGEtX2tfazBuVEY1aGRVWVR3RXdBa3NJYU51SEE9czk2LWM%3D%252Cr_max%252Cw_90%252Cx_87%252Cy_95%2Fv1627283836%2Fdefault%2Fog-base-w1200-v2.png)