adding-api-docs

Generate OpenAPI documentation from existing API routes and schemas.

672|104|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/spencerpauly/awesome-cursor-skills --skill adding-api-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adding-api-docs
Source: https://github.com/spencerpauly/awesome-cursor-skills/tree/main/resources/adding-api-docs
Command: npx skills add https://github.com/spencerpauly/awesome-cursor-skills --skill adding-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the repetitive work of writing and maintaining API documentation by turning existing routes, schemas, and auth details into a clear OpenAPI spec and docs site.

Core Features & Use Cases

  • Framework Detection: Adapts to common API stacks like Express, Fastify, Next.js API routes, Hono, Django REST Framework, and FastAPI.
  • Schema-Driven Docs: Documents request bodies, response types, examples, and authentication schemes so the API is easier to consume.
  • Interactive Documentation: Produces Swagger UI, Scalar, or ReDoc-style docs for developer-friendly API exploration.
  • Use Case: A backend team can generate and publish up-to-date API documentation directly from route handlers instead of maintaining a separate manual spec.

Quick Start

Ask the skill to generate OpenAPI documentation for your API, and it will infer the framework, document the endpoints, and create an interactive docs flow from your code.

Frequently Asked Questions about adding-api-docs

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

FAQPage Schema
How do I generate OpenAPI documentation from existing Express or FastAPI route handlers?

To generate OpenAPI documentation, the Skill detects your API framework, such as Express or FastAPI, and extracts endpoint specs, response schemas, and authentication schemes directly from your route handlers to produce an interactive docs site.

Can I automatically create Swagger UI for my Next.js API routes and Hono endpoints?

Yes, you can create Swagger UI for Next.js API routes and Hono endpoints. The Skill produces interactive documentation outputs like Swagger UI, Scalar, or ReDoc-style docs for developer-friendly API exploration.

How do I keep my API documentation in sync with my Django REST Framework code?

You keep API documentation in sync by generating the OpenAPI spec directly from your Django REST Framework code. The Skill synchronizes the documentation with the underlying code so the spec stays current without manual updates.

What is the best way to document API authentication schemes and response schemas?

The best way to document authentication schemes and response schemas is through schema-driven docs. The Skill documents request bodies, response types, examples, and auth schemes so the API is easier to consume.

Does this approach work for both Fastify and Django REST Framework API documentation tasks?

Yes, this approach works for Fastify and Django REST Framework. The Skill adapts to common API stacks including Express, Fastify, Next.js API routes, Hono, Django REST Framework, and FastAPI for documentation tasks.

Why does my generated API spec need accurate request and response schemas?

Your generated API spec needs accurate request and response schemas because the Skill requires them to produce a valid OpenAPI spec. Accurate schemas ensure the interactive documentation correctly reflects your API endpoints and authentication schemes.