API Design Line

Focuses on the design principles and practices for APIs.

Stations

1. API Platform Architecture

   Entry criteria

   • The API meets a clear business need and is reusable for multiple API consumers.
   • The API is intended to shield consumers from backend complexity and inconsistencies.
   • The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders.
   • API consumer segments (internal and external) are identified.
   • High-level roadmaps for API development are established.

2. API Design

   Entry criteria

   • The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders.
   • The API is intended to shield consumers from backend complexity and inconsistencies.
   • The API design and exposed capabilities clearly trace back to business value and user needs.
   • The API design follows our shared API product and design conventions.

3. API Delivery

   Entry criteria

   • The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders.
   • The API is intended to shield consumers from backend complexity and inconsistencies.
   • The API design and exposed capabilities clearly trace back to business value and user needs.
   • The API design follows our shared API product and design conventions.

4. API Audit

   Entry criteria

   • The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders.
   • The API design and exposed capabilities clearly trace back to business value and user needs.
   • The API and its exposed capabilities are described clearly enough for review, audit, and onboarding.
   • The API design follows our shared API product and design conventions.
   • The API contract is tested and meets functional and non-functional requirements.