api-docs

Name: api-docs
Availability: InStock
Author: andregusman-raiz

Generate OpenAPI 3.1 specs and Markdown docs from code or existing specs.

19|4|Updated Mar 7, 2026

Search Tags:#documentation #markdown #api #openapi #swagger #code-to-docs #endpoint-reference

Ready to run

npx skills add https://github.com/andregusman-raiz/a-gusman-claude --skill api-docs-andregusman-raiz

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/andregusman-raiz/a-gusman-claude/tree/main/skills/api-docs
Command: npx skills add https://github.com/andregusman-raiz/a-gusman-claude --skill api-docs-andregusman-raiz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates OpenAPI specifications, endpoint references, and Markdown API docs from code or existing specs, reducing manual drafting and keeping docs in sync with implementations.

Core Features & Use Cases

Generate OpenAPI 3.1 specifications from codebases (Next.js app router, FastAPI, and other frameworks).
Produce endpoint reference documentation and Markdown docs from OpenAPI specs, enabling easy onboarding and reference.
Validate and lint OpenAPI specs to ensure consistency and interoperability across tools.

Quick Start

Provide the path to your codebase or OpenAPI spec to generate API documentation.

Frequently Asked Questions about api-docs

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

FAQPage Schema

How do I generate OpenAPI specs from an existing FastAPI or Next.js codebase?▼

You can generate OpenAPI 3.1 specifications directly from your FastAPI or Next.js codebase by providing the path to your code. This process automatically drafts API documentation and endpoint references from your code, reducing manual effort and keeping docs in sync with implementations.

What's the best way to keep API documentation in sync with code changes?▼

The best way to keep API documentation in sync is to generate OpenAPI specifications and Markdown docs directly from your code or existing specs. This automated code-to-docs approach ensures your endpoint references accurately reflect current implementations without manual drafting.

Can I create Markdown endpoint reference docs from an OpenAPI spec?▼

Yes, you can produce Markdown endpoint reference documentation from existing OpenAPI specs. This enables developer onboarding and API reference generation by converting your swagger-ready specification into readable Markdown docs.

Does this approach enforce a specific OpenAPI version for generated specs?▼

Yes, this approach enforces OpenAPI 3.1 as the standard for all generated API specifications. It ensures consistency and interoperability across tools by validating and linting your swagger-ready specs using tooling like npx @redocly/cli lint openapi.yaml.

How do I validate and lint OpenAPI specs for consistency across tools?▼

You can validate and lint OpenAPI specs to ensure consistency and interoperability across tools by running npx @redocly/cli lint openapi.yaml. This enforces the OpenAPI 3.1 standard and guarantees your generated API documentation is valid.