OpenAPI Specification
OpenAPI仕様
OpenAPI仕様は、HTTP APIを言語に依存せずに記述する方法です。アクション、入力、データの形状、セキュリティ手法、応答、再利用可能なスキーマを一覧で示します。
もう一つの例
パートナーAPIは `POST /claims` とその必須の冪等性ヘッダーを説明します。また、OAuth スコープ、JSON スキーマ規則、201 および問題の応答、偽データを用いた例も一覧化します。CI は文書化されていない破壊的な応答をブロックします。生成されたクライアントは、チェックなしで信頼されるのではなく、依然としてレビューされます。
主な部分
- 01APIのメタデータとサーバー
- 02パスと操作
- 03スキーマ、セキュリティ、およびレスポンス
以下の場合に使用します
文書、チェック、モックサーバ、クライアント生成、互換性テストのために人々が確認できる契約として使用してください。
以下の場合は使用しないでください
生成されたドキュメントは、実際の例、認可テスト、実行時チェック、または明確な本番動作の代わりにはなりません。
コードで使用する名前
openapi document: paths, operations, components/schemas, securitySchemes, responses 出荷前に
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome:Complete the task with OpenAPI仕様 (OpenAPI Specification)。 User context:パートナーAPIは `POST /claims` とその必須の冪等性ヘッダーを説明します。また、OAuth スコープ、JSON スキーマ規則、201 および問題の応答、偽データを用いた例も一覧化します。CI は文書化されていない破壊的な応答をブロックします。生成されたクライアントは、チェックなしで信頼されるのではなく、依然としてレビューされます。 Technical concept or control:OpenAPI仕様 (OpenAPI Specification)。 Why it fits:文書、チェック、モックサーバ、クライアント生成、互換性テストのために人々が確認できる契約として使用してください。 Do not use it when:生成されたドキュメントは、実際の例、認可テスト、実行時チェック、または明確な本番動作の代わりにはなりません。 Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary):きちんとした書類でも、まだドラフトやリリース候補、あるいは最終版かもしれません。ステータスや、ブラウザやプラットフォームの対応状況を確認しましょう。 Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
このリクエストを確認する
Review how OpenAPI仕様 (OpenAPI Specification) is used now. Definition: OpenAPI仕様は、HTTP APIを言語に依存せずに記述する方法です。アクション、入力、データの形状、セキュリティ手法、応答、再利用可能なスキーマを一覧で示します。 Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.