OpenAPI リンター
OpenAPI/Swagger仕様の一般的な問題を検証
OpenAPI / Swagger（YAML または JSON）
Lint 結果
Lint 結果を表示するには OpenAPI ドキュメントを貼り付けてください。
提案
- より明確なドキュメントのために、各操作に概要や説明を追加してください。
- 重複を避けるため、components.schemas に再利用可能なスキーマを定義してください。
- コンテンツスキーマ付きの明示的な 2xx レスポンスを含めてください。
OpenAPI/Swagger仕様の一般的な問題を検証
OpenAPI（旧称 Swagger）は RESTful API を記述する標準です。このページでは OpenAPI ドキュメントを lint し、契約が一貫性・可読性・利用しやすさを備えているか確認します。
OpenAPI ドキュメントは、エンドポイント、メソッド、パラメータ、リクエスト／レスポンス本文、認証、再利用可能なコンポーネントを YAML または JSON で定義します。明確で検証済みの仕様は、ドキュメント生成、コード生成、テスト、自動化ガバナンスを支えます。
説明不足、曖昧なステータスコード、不整合なスキーマ、コンポーネント再利用の機会などを検出します。一貫した命名、明示的な content type、完全な例の提供を促し、SDK やクライアント統合時の摩擦を減らします。
POST /users に requestBody があるがスキーマや例がない場合、lint はこれを指摘し、components.schemas.User に JSON Schema を追加して $ref で参照し、201 や 400 レスポンスに例示ペイロードを追加することを提案します。
仕様を貼り付けると迅速なフィードバックを得られます。設計レビューや CI で活用し、読みやすくツールフレンドリーな仕様を維持してください。契約テストと併用して実装との整合性を確保します。
健全な API エコシステムは高品質な仕様から始まります。早期かつ継続的に lint を行い、開発者に愛されるドキュメントと SDK を提供しましょう。