現在、インターネット上には RESTful API (便宜上、以下では「RESTful API」を「API」と略します) の設計方法に関する記事が数多く溢れていますが、「普遍的な」設計基準はありません。認証するには? API形式とは何ですか?アプリの作成を開始するとき、特にバックエンド モデル部分が作成されているときは、アプリのパブリック API 部分を設計して実装するために多大な労力を費やす必要があります。なぜなら、一度リリースされてしまうと、外部に公開された API を変更するのは困難だからです。
質問 1:
メールを送信する /mail/1/send using POST /mail/send using POST
URL に名前を付ける方法
質問 2
特定のユーザー リストを取得する /getVipUser /user/vip /getUserList?type=vip
URL に名前を付ける方法
質問 3
ラクダ型とヘビ型のどちらを使用するか非常に迷っています。両方使用したことがあります。関係ないという人もいますが、まだ迷っています。
Restful は、単なる参照仕様のセットにすぎません。ソフトウェア開発の分野では、万能の仕様は存在しません。API については、簡単であればよいだけです。開発者が区別できるようにするためです。機能が実装されている限り、API がどのようなものであるかは気にする必要はありません。
Ruanyifeng のブログ投稿をチェックしてください:
http://www.ruanyifeng.com/blo...
キャメルケースとスネークケースのどちらを使用するかについては、すべて小文字にする必要があります
vip
可以作为一个资源GET vips/user/{id}
ORGET users/vip/{id}
获取单个资源GET vips/user
ORGET users/vip
複数のリソースを取得します次のリソースを参照するとよいでしょう:restful-api-design-references - RESTful API 設計リファレンス リスト。REST スタイルのインターフェイス設計をより完全に理解するのに役立ちます。
RESTful APIの実践においてはモデルともいえるGithub API v3の設計もご覧いただけます。