APIレスポンスの命名規則:包括的ガイド

4 分で読了

APIレスポンスのフィールド名を一貫させることで、混乱を減らしAPIを直感的にできます。

よくあるパターン

フィールド型パターン
IDリソース + Id/iduserIdorderId
タイムスタンプ動詞 + At/atcreatedAtupdatedAt
Booleanis/has + 形容詞isActivehasVerified
カウント名詞 + CountitemCountpageCount
URL名詞 + UrlavatarUrlwebsiteUrl

ページネーション

{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }

変換

camelCase JSONキーコンバーターまたはsnake_case JSONキーコンバーターをご利用ください。