WhoNot selectedWhyNot selectedWhereAPI DesignCycleAPI Productization CycleDesign Line

Station

API Design

Create API designs that are consistent, reusable, and grounded in business intent and shared standards.

Designing APIs is not just about naming endpoints. Good design ensures APIs are usable, consistent, and aligned with business and technical goals. Poor design leads to tight coupling, low reuse, and costly rework across teams.

Method map

Navigate the method

Select a station, cycle, or stakeholder perspective to explore the method.

StrategicGovernanceConsumerTechnicalUser ExperienceUser ExperienceMarket InsightsMarket InsightsBusiness GoalsBusiness GoalsCompetitive AnalysisCompetitive AnalysisEcosystem VisionEcosystem VisionScalable InfrastructureScalable InfrastructureLegal and ComplianceLegal and ComplianceSecurity and PrivacySecurity and PrivacyDesign StandardsDesign StandardsVendor ManagementVendor ManagementContract DesignContract DesignDevelopmentDevelopmentCI/CDCI/CDTest AutomationTest AutomationRelease ManagementRelease ManagementService AgreementsService AgreementsConsumer AdoptionConsumer AdoptionPromotionPromotionPartner IntegrationPartner IntegrationAPI MindsetAPI MindsetRoles and ResponsibilitiesRoles and ResponsibilitiesUpskillingUpskillingOperating GuidelinesOperating GuidelinesPortfolio ManagementPortfolio ManagementBudget and Resource ManagementBudget and Resource ManagementStrategy1API Product StrategyConsumer Requirements & Onboarding2API Consumer ExperienceArchitecture & Platform Decisions3API PlatformArchitectureSolution & Interface Design4API DesignDelivery & Operations5API DeliveryQuality & Readiness Assurance6API AuditPublishing & Enablement7API PublishingMonitoring & Improvement8API Monitoring &ImprovementBusiness Opportunities LinePlatform Architecture LineDesign LineDelivery LinePublishing and Adoption LineOperating Model Line

Outcomes

  • Well-documented and consistent API designs
  • Reusable and validated API contracts
  • Designs aligned with domain models and interaction patterns
  • Design traceability to business value

Journey criteria

Entry criteria

  • The capability addresses a clear business need and is reusable by its intended consumers.
  • The selected interface provides an appropriate abstraction for consumers.
  • The capability value proposition has been validated with business and consumer stakeholders.
  • Consumer segments are identified.
  • A high-level implementation roadmap is defined.

Exit 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.

People to involve

Related resources

canvasInteraction CanvasDefine interactions, workflows, inputs, outputs, commands, queries, events, and expected responses to ensure a consistent consumer experience.
View details & edit hereOpen in CanvasCreator
canvasREST CanvasDesign APIs using RESTful principles, defining resources, verbs, and example requests and responses.
View details & edit hereOpen in CanvasCreator
canvasEvent CanvasDesign event-driven interfaces and integrations by defining events, triggers, schemas, producers, consumers, and processing logic.
View details & edit hereOpen in CanvasCreator
guidelineAPI Design PrinciplesA concise guide to API usability, discoverability, and consistency grounded in shared design rules and real consumer needs.
canvasDomain CanvasA modeling tool to define and communicate the key entities and relationships in your domain, ensuring semantic consistency across capabilities, integrations, APIs, data products, and services.
View details & edit hereOpen in CanvasCreator

Metro lines

Design Line

Focuses on solution and interface design principles that can be used across APIs, integrations, automations, data products, and other implementation styles.

Use these decks to introduce the method or discuss it with your team. View online or download PowerPoint and PDF.