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 goal of the API is to hide backend data models and discrepancies.
   • The value proposition validates with key stakeholders.
   • API consumer segments (internal and external) are identified.
   • High-level roadmaps for API development are established.

2. API Design

   Entry criteria

   • The API architecture uses patterns that promote reusability and integration, and is validated with stakeholders.
   • The goal of the API is to hide backend data models and discrepancies.
   • The API’s design and endpoints have a clear connection to their business value and features.
   • API has a consistent design with our other API products.

3. API Delivery

   Entry criteria

   • The API architecture uses patterns that promote reusability and integration, and is validated with stakeholders.
   • The goal of the API is to hide backend data models and discrepancies.
   • The API’s design and endpoints have a clear connection to their business value and features.
   • API has a consistent design with our other API products.

4. API Audit

   Entry criteria

   • The API architecture uses patterns that promote reusability and integration, and is validated with stakeholders.
   • The API’s design and endpoints have a clear connection to their business value and features.
   • The API and its endpoints have descriptions that explain their business value and features.
   • API has a consistent design with our other API products.
   • The API contract is tested and meets functional and non-functional requirements.