API Gateway Developer Console Interaction Matrix
Structure API documentation, interactive sandboxes, and gateway error feedback into an integrated developer portal matrix.
Use this template when designing enterprise API developer portals and gateway management consoles. It establishes UX standards for endpoint documentation, mock payload validation, token management, and real-time HTTP response visualization.
Role: Lead Enterprise API Experience Architect focused on developer platform onboarding and gateway usability.
Context
- Protocol architecture: {{api_protocol_standard}}
- Auth workflows: {{authentication_mechanisms}}
- Target consumer: {{target_developer_cohort}}
- Data contract complexity: {{payload_complexity_tier}}
- Rate-limit policies: {{gateway_throttling_rules}}
- Active lifecycle phase: {{integration_lifecycle_stage}}
Task
Design an API Gateway console interaction matrix that specifies user interface layouts, request/response validation feedback, schema explorer ergonomics, and authentication state cues for integration developers.
Method
- Map the technical constraints of {{api_protocol_standard}} into interactive documentation and schema viewing components.
- Define visual states for {{authentication_mechanisms}}, highlighting credential expiry, missing scopes, and signing errors.
- Create progressive disclosure controls tailored to {{payload_complexity_tier}} to enable readable schema navigation.
- Design intuitive in-console feedback patterns for {{gateway_throttling_rules}} (headers, retry counters, graphical quota gauges).
- Align console affordances with the goals of {{target_developer_cohort}} during the {{integration_lifecycle_stage}} phase.
- Specify interactive sandbox behaviors, including auto-complete, mock data generation, and cURL/SDK export buttons.
- Consolidate component states, error treatments, and feedback mechanisms into a clear design matrix.
Constraints
- MUST deliver the core specification as a structured Markdown interaction matrix.
- MUST NOT create generic web form designs that omit specific {{api_protocol_standard}} protocol requirements.
- MUST provide actionable inline recovery UI for every HTTP 4xx and 5xx error pattern.
- The matrix MUST explicitly define empty, loading, success, and partial-error component states.
Output format
- Section 1: Portal UX Architecture Framework (100-150 words defining layout grid, navigation split, and sandbox panel placement).
- Section 2: Gateway Console Interaction Matrix (Markdown table with columns: Portal Sub-Component, User Task / Trigger, Protocol State ({{api_protocol_standard}}), Visual UI Pattern, Error / Throttling Feedback State).
- Section 3: Developer Feedback Guidelines (4-5 bulleted design rules governing syntax highlighting, payload copy actions, and credential masking).
Self-review
- Ensure all 6 context variables are actively utilized in the matrix structure and guidelines.
- Check that authentication failure states for {{authentication_mechanisms}} provide explicit debugging guidance.
- Confirm that formatting adheres strictly to Markdown matrix specifications without unnecessary prose.
Explicit role, a named task, and discrete steps the model can follow.
Background, inputs and variables the model needs before it starts.
Hard boundaries — what the model must and must not do.
A named, field-level shape for the response.
Ordered work items that force analysis before an answer.
Length and structure that travel across frontier models.
Signal density — instruction weight without padding.
Documented variables so the scaffold adapts to new inputs.
Quality bar, assumptions and behaviour when inputs are thin.
How much real usage the template has behind it.