Focuses on solution and interface design principles that can be used across APIs, integrations, automations, data products, and other implementation styles.
Station
API Audit
Validate that APIs meet business, design, and operational standards before release.
APIs are long-lived products and must meet expectations for quality, consistency, and compliance. The audit connects design decisions, implementation, and operational readiness to defined standards, reducing risk before exposure.
Method map
Metro map
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Quality & Readiness Assurance
People to involve
Related resources
Outcomes
- APIs meet internal and external standards
- Clear documentation of API design and implementation decisions
- Security, performance, and compliance validated
- Reduced risk of issues in production
Journey criteria
Entry criteria
- The chosen architecture, platform, and implementation style have been validated with the relevant architecture, security, and platform stakeholders.
- The selected interface provides an appropriate abstraction for consumers.
- The interface design and exposed capabilities trace back to business value and consumer needs.
- The interface design follows agreed design standards and conventions.
Exit criteria
- The chosen architecture, platform, and implementation style have been validated with the relevant architecture, security, and platform stakeholders.
- The interface design and exposed capabilities trace back to business value and consumer needs.
- The interface and its capabilities are documented clearly enough for review, audit, and onboarding.
- The interface design follows agreed design standards and conventions.
- The interface contract has been validated and tested against functional and non-functional requirements.
This is what success looks like
Establish a consistent audit process that evaluates API readiness across lifecycle stages using defined criteria, evidence, and standards. Ensure gaps are identified early and resolved before release.
- Conduct audits to ensure APIs meet organizational, technical, and legal standards before release. — API Audit Checklist
- Use checklists, linters, and testing tools to verify consistency and conformance with standards.
- Collaborate with governance teams and domain experts to ensure APIs are ready for production.
Metro lines
Focuses on publishing reusable capabilities and enabling adoption by consumers.
Review station resources
Browse the resources selected for API Audit; the summary above explains how they support this station’s work.
Station resources
Resources for API Audit
checklist
API Audit Checklist
A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.
Outcomes
- Shared understanding of the purpose and use of API Audit Checklist
- A consistent approach to applying API Audit Checklist
- Improved application of the related practices
How it works
- Use the API Audit Checklist to ensure the API design meets functional and non-functional requirements, including security, performance, and compliance.
- Conduct audits to assess lifecycle coverage and verify that the API meets business, design, and operational standards.
- Ensure that documentation, security models, gateway configuration, and legal requirements are clearly defined, validated, and supported by evidence.
Relevant cycles
Capability Productization Cycle
A cycle for turning business capabilities into reusable digital capabilities before selecting the implementation style.
API Productization Cycle
The API-focused APIOps Cycles journey for productizing, designing, delivering, publishing, and improving APIs.
Integration Productization Cycle
A cycle for productizing reusable integration capabilities before selecting the implementation style.
Automation Cycle
A cycle for identifying, designing, delivering, enabling, and improving automation opportunities.