08. Design API / interfaces
Define input, output, status codes, authorization, and errors for each use case.
What it is
Define input, output, status codes, authorization, and errors for each use case.
When to use it
Workflow step 8 of 17. Apply before moving to the next decision.
Syntax
8. Design API / interfaces
Define input, output, status codes, authorization, and errors for each use case.Example
POST /transfers accepts source/destination IDs and amount.
201: created; 422: invalid input; 403: forbidden; 409: conflicting state.
Document duplicate request behavior.Common mistakes
Skipping this decision makes later implementation depend on unstated assumptions.