APIレスポンスの命名規則:包括的ガイド
4 分で読了
APIレスポンスのフィールド名を一貫させることで、混乱を減らしAPIを直感的にできます。
よくあるパターン
| フィールド型 | パターン | 例 |
|---|---|---|
| ID | リソース + Id/id | userId、orderId |
| タイムスタンプ | 動詞 + At/at | createdAt、updatedAt |
| Boolean | is/has + 形容詞 | isActive、hasVerified |
| カウント | 名詞 + Count | itemCount、pageCount |
| URL | 名詞 + Url | avatarUrl、websiteUrl |
ページネーション
{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }
変換
camelCase JSONキーコンバーターまたはsnake_case JSONキーコンバーターをご利用ください。