API & Endpoint
API とエンドポイント
APIは、ソフトウェアがソフトウェアと通信するためのルールの集合です。エンドポイントは、そのAPI内の1つのアドレスと1つの操作です。
もう一つの例
アプリは GET /api/projects を呼び出します。APIドキュメントのレスポンス形式でプロジェクトデータを取得します。
主な部分
- 01Originating request
- 02Resolution or processing hop
- 03Response, timing, and failure
以下の場合に使用します
API契約書には、そのメソッド、スキーマ、エラー、権限、およびバージョンを明確に記載する必要があります。
以下の場合は使用しないでください
変更される可能性のあるプライベートデータベースの構造や実装の詳細を公開してはいけません。
コードで使用する名前
HTTP method + route + schema 出荷前に
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 API とエンドポイント (API & Endpoint)。 User context:アプリは GET /api/projects を呼び出します。APIドキュメントのレスポンス形式でプロジェクトデータを取得します。 Technical concept or control:API とエンドポイント (API & Endpoint)。 Why it fits:API契約書には、そのメソッド、スキーマ、エラー、権限、およびバージョンを明確に記載する必要があります。 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 API とエンドポイント (API & Endpoint) is used now. Definition: APIは、ソフトウェアがソフトウェアと通信するためのルールの集合です。エンドポイントは、そのAPI内の1つのアドレスと1つの操作です。 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.