REST API命名、なぜルールが重要なのか
REST APIはURL構造自体がドキュメントの役割を兼ねます。うまく設計されたエンドポイントは追加の説明なしでも「何を扱うリソースなのか」がすぐ分かりますが、大文字小文字が混在したりアンダースコアと動詞が入り混じると、共同作業時の混乱が増え、クライアント側のコードでも例外処理が増えます。代表的なRESTful原則は、リソースを名詞(できれば複数形)で表現し、動作はHTTPメソッド(GET/POST/PUT/DELETE)で区別し、小文字とハイフンのみを使うケバブケースに従うことです。
このチェッカーは入力したエンドポイントURLを5つの基準(小文字使用、ケバブケース、動詞不使用、末尾スラッシュ、ファイル拡張子)で自動点検し、100点満点のスコアとグレードを知らせます。新しいAPIを設計する時や既存のAPIドキュメントをレビューする時、チームの命名規則を作る前に素早く点検する用途で活用してください。
よくある質問
RESTful URLに動詞を使ってはいけない理由は何ですか?
RESTはリソースを名詞で、動作はHTTPメソッドで表現する方式です。URLに動詞が入るとメソッドと意味が重複し、設計原則から外れます。
ケバブケース(kebab-case)を使うべき理由は何ですか?
URLは大文字小文字を区別するシステムと区別しないシステムが混在しているため、小文字とハイフンのみを使うケバブケースが最も安全で読みやすいです。