API & Endpoint
An API is a set of rules for software to talk to software. An endpoint is one address and one operation in that API.
Another example
The app calls GET /api/projects. It gets project data in the response shape from the API docs.
Main parts
- 01Originating request
- 02Resolution or processing hop
- 03Response, timing, and failure
Use it when
The API contract should state its methods, schemas, errors, permissions, and versions clearly.
Do not use it when
Never expose the private database shape or implementation details that may change.
Name used in code
HTTP method + route + schema Before you ship
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: Design or review API & Endpoint for this system while keeping data correct, secure, and easy to operate. User context: The app calls GET /api/projects. It gets project data in the response shape from the API docs. Technical concept or control: API & Endpoint. Why it fits: The API contract should state its methods, schemas, errors, permissions, and versions clearly. Do not use it when: Never expose the private database shape or implementation details that may change. 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): No single official standard controls the whole term. Its meaning may change across teams, platforms, or frameworks. 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.
Check this request
Review the current use of API & Endpoint. Definition: An API is a set of rules for software to talk to software. An endpoint is one address and one operation in that 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, report the evidence you found, gaps, severity, and the smallest safe fix.