Stakeholder guide

API Designer

Shapes the interface contract, interaction model, consistency, and usability of the exposed capabilities.

Relevant cycles

API Productization Cycle

The API-focused APIOps Cycles journey for productizing, designing, delivering, publishing, and improving APIs.

Automation Cycle

A cycle for identifying, designing, delivering, enabling, and improving automation opportunities.

Relevant stations

  • Solution & Interface Design

    Design the interface contract and interaction model after the architecture choice is justified.

  • Delivery & Operations

    Deliver the selected implementation style with appropriate engineering, testing, security, automation, and operational practices.

  • Quality & Readiness Assurance

    Audit the capability interface contract, controls, support model, observability, documentation, and lifecycle readiness before release.

  • Consumer Requirements & Onboarding

    Capture consumer onboarding, standards, non-functional requirements, service expectations, constraints, security needs, allowed protocols, data freshness, SLAs, observability, recovery, adoption requirements, and producer responsibilities.

Decisions and outputs

Decisions

  • Reuse the Domain Canvas to confirm business objects, terms, rules, and ownership before contract design.
  • Use the Interaction Canvas to describe how consumers, systems, or users interact with the capability.
  • Use REST design resources when the selected interface is a REST API.
  • Use Event Canvas resources when the selected interface is event-driven.
  • Use GraphQL design resources when the selected interface is GraphQL.
  • Use the design principles and style guidance to align design decisions with shared rules and enable consistent audit validation.

Outputs

  • A validated interface contract for the selected implementation style
  • Consistent interaction, data, event, file, workflow, or API contract decisions
  • Design traceability back to capability and consumer requirements
  • Designs aligned with domain models and interaction patterns
  • spec
  • contract
  • design-artifact
  • documentation

Recommended resources

Facilitate as API Designer

Use these prepared prompts alongside the stakeholder decisions, outputs, stations, and resources summarized above.

AI facilitation

Prompt pack

Facilitate a station with API Designer

facilitate-station

Stakeholder: API Designer
Cycles: Capability Productization Cycle, API Productization Cycle, Integration Productization Cycle, Automation Cycle
Stations: Solution & Interface Design, Delivery & Operations, Quality & Readiness Assurance, Consumer Requirements & Onboarding
Resources and canvases: Domain Canvas, Interaction Canvas, Consumer Experience Requirements Canvas, REST Canvas, Event Canvas, GraphQL Canvas, API Value Proposition Canvas, Customer Journey Canvas

Act as an APIOps Cycles facilitator. Use the selected station questions, entry criteria, exit criteria, stakeholders, and related resources to guide the discussion. Produce decisions, evidence gaps, and next steps.