api

Design and validate OpenAPI 3.1 specifications for REST, GraphQL, and gRPC services.

26|8|Updated Mar 19, 2026
One-click install
npx skills add https://github.com/arbazkhan971/godmode --skill api-arbazkhan971
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api
Source: https://github.com/arbazkhan971/godmode/tree/main/skills/api
Command: npx skills add https://github.com/arbazkhan971/godmode --skill api-arbazkhan971

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It removes uncertainty and manual work from API design by producing consistent, versioned, and validated API specifications that serve as the source of truth before implementation. The Skill ensures every endpoint has a clear contract, example requests and responses, pagination, error schemas, and rate limiting so teams avoid breaking changes and inconsistent behavior.

Core Features & Use Cases

  • Generates complete OpenAPI 3.1 specifications (or equivalent GraphQL SDL / protobuf for gRPC) from resource models and requirements.
  • Enforces versioning, consistent error response formats, mandatory pagination for list endpoints, rate limiting policies, and auth models (API key, OAuth2, JWT, mTLS).
  • Validates specs with standard tooling (spectral, redocly, swagger-cli, oasdiff) and prevents commits when breaking changes or validation errors exist.
  • Auto-detects existing frameworks, OpenAPI/protobuf/GraphQL artifacts, and route patterns to bootstrap designs for new or legacy services.
  • Produces deliverables: docs/api/<service>-openapi.yaml, design doc, example request/response pairs, and Postman/Insomnia collections.
  • Use case: Convert an undocumented service into a production-ready, versioned OpenAPI contract with cursor pagination, consistent error schema, and rate limiting tiers.

Quick Start

Design a REST OpenAPI 3.1 specification for an Orders service with CRUD endpoints, cursor pagination, JWT authentication, and tiered rate limits.

Frequently Asked Questions about api

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 microservice?

To generate an OpenAPI 3.1 specification, provide resource models and service requirements to automatically produce a complete contract with endpoints, example payloads, pagination, and authentication schemas.

Can I validate existing OpenAPI or protobuf artifacts for breaking changes?

Yes, existing OpenAPI, protobuf, or GraphQL SDL artifacts can be validated using standard tooling like spectral, redocly, and oasdiff to prevent commits when breaking changes or validation errors are detected.

How do I enforce consistent error schemas and pagination across REST APIs?

Enforce consistent error schemas and pagination by generating standardized OpenAPI contracts that mandate cursor pagination for list endpoints and apply uniform error response formats across all services.

Does this work with GraphQL SDL and gRPC protobuf definitions?

Yes, the design and validation process applies to REST, GraphQL, and gRPC services, producing equivalent GraphQL SDL or protobuf definitions alongside OpenAPI 3.1 specifications when creating or documenting APIs.

What is the best way to document an undocumented legacy service API?

The best way to document a legacy service is to auto-detect existing frameworks and route patterns to bootstrap a production-ready, versioned OpenAPI contract complete with rate limiting tiers and example request/response pairs.

How do I add rate limiting policies and JWT authentication to an API design?

Add rate limiting policies and JWT authentication by defining auth models like API key, OAuth2, JWT, or mTLS directly within the generated OpenAPI specification to enforce tiered access limits.