API Path Guidelines

パスの基本形式

サービス名、バージョン、リソース名を含めた一貫したパス形式を定義してください。

https://{DOMAIN}/{SERVICE_NAME}/{VERSION}/{RESOURCE}

リソースパスに動詞を含めない

NG:
/articles/create
/articles/update
/articles/delete

OK:
/articles
/articles/{article_id}

リソースパスには複数形の名詞を使用する

NG:
/article

OK:
/articles

パスの末尾にスラッシュ（/）を付けない

NG:
/articles/

OK:
/articles

複数単語のリソースパスは kebab-case（ハイフン区切り）を使う

NG:
/newsArticles
/news_articles

OK:
/news-articles

リソースパスに大文字を使わない

NG:
/Articles

OK:
/articles

クエリパラメータには snake_case を使う

パスは kebab-case、クエリパラメータは snake_case に統一します。

NG:
/articles?page=1&pageSize=10
/articles?page=1&page-size=10

OK:
/articles?page=1&page_size=10