skills.rest
camilooscargbaptista
camilooscargbaptistaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-documentation

Generate and review OpenAPI 3.1 specs for REST and GraphQL APIs.

7|Updated Mar 19, 2026
Search Tags:#documentation#openapi#rest#graphql#swagger#api-design
One-click install
npx skills add https://github.com/camilooscargbaptista/cto-toolkit --skill api-documentation-camilooscargbaptista
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/camilooscargbaptista/cto-toolkit/tree/main/api-documentation
Command: npx skills add https://github.com/camilooscargbaptista/cto-toolkit --skill api-documentation-camilooscargbaptista

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API documentation is often incomplete, inconsistent, or out of sync with implementation, causing integration errors, slow developer onboarding, and support overhead. This Skill streamlines creation and review of API specs and narrative docs so integrations work reliably and teams ship faster.

Core Features & Use Cases

  • OpenAPI/Swagger Generation & Review: Create, validate, and improve OpenAPI 3.1 specs for RESTful services and produce reference docs for GraphQL schemas.
  • Reusable Schema & Error Patterns: Provide schema definitions, standard problem-details error formats, pagination patterns, authentication examples, and common response components.
  • Code-Generation Guidance: Offer annotations and examples for NestJS and Spring Boot to keep specs aligned with code and enable SDK generation.
  • Use Case: Convert API annotations or a verbal API description into a complete spec with examples, idempotency guidance, headers, and sample responses for client teams.

Quick Start

Generate an OpenAPI 3.1 specification for a payments API including authentication, rate limits, pagination, error schemas, and example requests and responses.

Frequently Asked Questions about api-documentation

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 REST API?▼

You can generate a complete OpenAPI 3.1 specification by providing a verbal API description or existing annotations. The output includes reusable schema components, standard error formats, pagination patterns, and example requests and responses.

What is the best way to document a GraphQL API schema?▼

The best way to document a GraphQL API schema is to generate structured reference documentation directly from the schema definitions. This ensures integrators have clear details on types, queries, and mutations for reliable onboarding.

Can I use this to review and validate my existing Swagger specifications?▼

Yes, you can review and validate existing Swagger specifications. The process checks for API contract consistency across versions and improves missing elements like schema definitions, idempotency guidance, headers, and standard problem-details error formats.

Does API documentation generation work with NestJS and Spring Boot?▼

Yes, API documentation generation provides code-generation guidance and annotations for NestJS and Spring Boot. This keeps your OpenAPI specifications aligned with your backend code and enables reliable SDK generation.

How do I add standard error schemas and pagination patterns to my API docs?▼

You add standard error schemas and pagination patterns by generating OpenAPI 3.1-compliant specs with reusable components. This includes standard problem-details error formats, authentication examples, and common response components for client teams.

Related Skills

Explore More Software Engineering Skills→
elsolalelsolal
1

api-designer

Design OpenAPI specifications and documentation for REST and GraphQL services.

Community
Advanced
berea-chberea-ch

extract-openapi-from-code

Extract OpenAPI specifications from API codebases in JSON or YAML.

Official
Advanced
CarlosEGuerraSilvaCarlosEGuerraSilva

extract-openapi-from-code

Extract OpenAPI specifications from API codebases using the Speakeasy CLI.

Community
Intermediate
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate