data_object
Doing the API work
API Audit ensures APIs meet standards and style guide, compliance, performance, and security requirements during design and deployment.
check_box
API Audit
login
Entry criteria
- The API is developed to support reusability for multiple API-consumers.
- The API and its endpoints have descriptions that explain its business value and features.
- API contract has a consistent design with our other API products and design guidelines.
- API is deployed to staging or production.
- API has been tested and meets functional and non-functional requirements.
- Monitoring and alerts are configured.
logout
Exit criteria
- The API is ready to be published to the appropriate gateways and environments to support reusability for multiple API consumers.
- The API passes design audits.
- The API passes compliance and security tests.
- Audit reports are shared with stakeholders.
- API documentation is ready.
- Access mechanisms are defined.
settings
Enabling the API work
- Create governance frameworks and tools for validating API compliance, performance, and security.
- Monitor that APIs meet the validation criteria.
View the checklist and read a 15 min case study on how to use it with a real API, or watch the video.
