URI設計
単語は複数形にする
単語はハイフンでつなげる※ハイフンでつなげるくらいなら区切る
例
△ api/users-matching
◯ api/users/matching
レスポンスデータフォーマット
エラーにHTMLを含めない
サービス閉塞時は503を返して、クライアント側がいつ再開できるか分かるようにしてあげる
セマンティックバージョニング
1.2.3のような表記のバージョン記法のこと
メジャー: 1にあたるところ: 後方互換しない大きな機能変更
マイナー: 2にあたるところ: 後方互換する機能追加変更
パッチ: 3にあたるところ: 後方互換するバグ修正