← Template library
TEMPLATE LIBRARY / TECHNICAL BA
API requirement checklist
Cover contract, security, errors and operations.
Working structure
Use these prompts as a starting point. Remove fields that do not help the decision and add the context your project needs.
Purpose and owner
Consumer, provider and business event.
Endpoint and method
Resource and operation.
Payload
Fields, types, validation and mapping.
Security
Authentication, authorisation and data classification.
Errors and retries
Codes, timeout, idempotency and fallback.
Operations
Logging, monitoring, versioning and reconciliation.