Web APIは外部連携のために公開するだけでなく、システム内部での利用も一般的になっており、重要性はますます高まっています。しかし、APIデザインについての知見はまだ広く浸透していません。書籍やオンライン情報はいろいろありますが、本セッションではその中から重要な要素をピックアップし、実際の著名なサービスに適用されている例も取り上げながら解説します。すぐに開発現場で役立ちます!Developers Summit 2025での発表資料です。
利用者がすべき振る舞いが明確になる ◦ RFC7807 Problem Details for HTTP APIs の利用 • API のどこでも同じ エラー形式を使用する @postman_japan HTTP/1.1 403 Forbidden Content-Type: application/problem+json Content-Language: en { "type": "https://example.com/probs/out-of-credit", "title": "You do not have enough credit.", "detail": "Your current balance is 30, but that costs 50.", "instance": "/account/12345/msgs/abc", "balance": 30, "accounts": ["/account/12345", "/account/67890"] }