WEB APIにおけるベストプラクティスを考える。
web-apiを設計する際汎用的に使える方法を各サイトを参考にしつつに考えてみました。
URL
一般的に、ケバブケースが多くURLはケバブケースで統一がよい思います。
返却するパラメータ
返却するパラメータはフロントがJSで書かれてる場合はキャメルケースが良いと思います。
返却するパラメータを考える際に、DBはスネークケースで表記されているので
どこかで変換をかける必要があります。
POSTするデータ
DBと同じスネークケースでもいいあなぁと思ってましたが、キャメルケースが一般的ぽい。
スマレジなんかは、postするデータはスネークケースで、返却されるパラメータはキャメルケース。
統一した方がいいんかなぁと迷い所
saleforceのドキュメントとかはさすがにリクエストもレスポンスもキャメルケースで入れてる。
基本は、リクエストボディもレスポンスボディもキャメルケースで統一が一般的ぽい
URL設計
下記を参照する限りトレンドは下記のような書き方ぽい。
https://api.example.com/1/***laravel使うとデフォルトが/api/って入るからlaravel使うなら別でもいいかなぁと思う。
実際下記は存在するパターン
https://api.pingdom.com/api/2.0/***