skills.rest
wesleyegberto
wesleyegbertoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-designer

Generate OpenAPI 3.1 specifications and resource models for REST and GraphQL APIs.

3|2|Updated Mar 23, 2026
Search Tags:#versioning#openapi#rest#graphql#error-handling#api-design#resource-modeling
One-click install
npx skills add https://github.com/wesleyegberto/software-engineering-skills --skill api-designer-wesleyegberto
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/wesleyegberto/software-engineering-skills/tree/main/plugins/programming-skills/skills/api-designer
Command: npx skills add https://github.com/wesleyegberto/software-engineering-skills --skill api-designer-wesleyegberto

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Design teams need a structured approach to API architecture to ensure consistent contracts across REST and GraphQL services.

Core Features & Use Cases

  • OpenAPI 3.1-compliant specifications to define APIs
  • Resource modeling and API governance for scalable architectures
  • Versioning, pagination, and standardized error handling strategies
  • Use Case: When starting a new service, generate a contract-first API design that teams can implement

Quick Start

Provide a ready-to-use OpenAPI 3.1 specification and resource models for a new API design project.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate an OpenAPI 3.1 specification for a new REST API?▼

To generate an OpenAPI 3.1 specification for a new REST API, define your resource models and standardized error handling. This produces a structured, contract-first API design that teams can implement directly.

What is the best way to design API versioning and pagination strategies?▼

The best way to design API versioning and pagination strategies is by applying scalable API governance guidelines during resource modeling. This ensures consistent contracts across REST and GraphQL services.

Does contract-first API design work for both REST and GraphQL services?▼

Yes, contract-first API design works for both REST and GraphQL services. It applies resource modeling patterns and standardized error handling to ensure consistent architecture across different API types.

How do I model resources and standardize error handling for scalable APIs?▼

To model resources and standardize error handling for scalable APIs, apply structured API governance guidelines. This enforces OpenAPI 3.1 compatibility and ensures consistent service contracts.

When do I need to enforce OpenAPI 3.1 compatibility in API design?▼

You need to enforce OpenAPI 3.1 compatibility in API design when starting a new service that requires structured architecture. It ensures consistent contracts and scalable API governance across teams.

Related Skills

Explore More Software Engineering Skills→
parhummparhumm
25

backend-api-contract

Generate OpenAPI 3.1 contracts from API resource entities, PRDs, or database schemas.

Community
Advanced
ccfccf

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from design or code sources.

Community
Advanced
ldilovldilov
3

api-contract-review

Review API contracts for breaking changes, versioning, and governance gaps.

Community
Basic
JayRHaJayRHa
3

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 or GraphQL SDL contracts.

Community
Advanced