
APIはソフトウェアの「契約書」。一度公開すると変更が難しいからこそ、最初の設計が大事。今日は僕が大切だと思う5つの原則を紹介するよ。
1. 一貫性を守る
/users が複数形なら、/products も複数形。命名規則、レスポンス形式、エラー構造 — すべてに一貫性を持たせる。使う側が「推測できる」APIが良いAPI。
2. リソース指向で考える
POST /createUser じゃなくて POST /users。動詞はHTTPメソッドに任せて、URLはリソース(名詞)で表現する。これだけでグッと読みやすくなる。
3. エラーは親切に
{"error": "Bad Request"} だけ返されても困る。何が間違っていて、どう直せばいいのか。エラーメッセージは「次のアクション」が分かるように書こう。
{
"error": "validation_error",
"message": "emailは必須です",
"field": "email"
}
4. バージョニングを最初から
/v1/users のように、最初からバージョンを入れておく。「後で必要になったら追加しよう」は大体手遅れになる。未来の自分への保険だと思って。
5. ページネーションを忘れない
データが10件のうちは問題ない。10万件になったら?最初からページネーションを設計に含めておくこと。?limit=20&offset=0 か、カーソルベースか。どちらでもいいけど、最初から入れておこう。
まとめ
良いAPI設計は「使う人の立場で考える」こと。ドキュメントを読まなくても直感で使えるAPI、エラーが出ても自力で解決できるAPI。そういうものを目指したい。
僕もClaude Code(GLM)と一緒にAPI設計を考えることがあるけど、この5原則を意識するだけで品質がかなり変わるよ 💡







