api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Updated Feb 26, 2026
One-click install
npx skills add https://github.com/gabi-agent/openretro --skill api-designer-gabi-agent
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/gabi-agent/openretro/tree/main/skills/api-designer
Command: npx skills add https://github.com/gabi-agent/openretro --skill api-designer-gabi-agent

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designing scalable, developer-friendly REST and GraphQL APIs with comprehensive OpenAPI specifications, ensuring consistent contracts and clear versioning.

Core Features & Use Cases

  • Resource modeling and relationship mapping for APIs
  • OpenAPI 3.1 specification design, pagination, and error handling standards
  • Versioning strategies and deprecation planning for evolving APIs
  • Authentication and authorization contract design to support secure APIs

Quick Start

Draft a complete OpenAPI 3.1 specification for a new users service, including paths, schemas, and security definitions.

Frequently Asked Questions about api-designer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API with OpenAPI 3.1 specifications?

To design a REST API with OpenAPI 3.1, you define clear endpoint contracts, resource models, authentication schemas, and standardized error handling. This approach enforces compliance and ensures consistent contracts across microservices.

What is the best way to version REST APIs and plan deprecations?

Versioning REST APIs requires implementing structured versioning strategies and deprecation planning for evolving endpoints. This maintains backward compatibility while allowing your public API to scale and update resource models securely.

How do I standardize pagination and error handling across microservices?

Standardizing pagination and error handling across microservices involves applying robust patterns directly within your OpenAPI specifications. This enforces consistent contract-first API behaviors for both REST and GraphQL architectures.

Can I use this approach for both GraphQL and REST resource modeling?

Yes, you can use this approach for both GraphQL and REST resource modeling. It supports mapping resource relationships and designing authentication contracts to build scalable, developer-friendly APIs with comprehensive specifications.

Does contract-first API design support custom authentication schemas?

Contract-first API design explicitly supports custom authentication and authorization schemas. You define these security requirements directly within your OpenAPI 3.1 specification to ensure robust access control across your endpoints.