Api Docs

Name: Api Docs
Author: girijashankarj

girijashankarj/cursor-handbook

1 installs
27 repo stars
Updated April 25, 2026
girijashankarj/cursor-handbook

Workflow for creating comprehensive API documentation: inventory endpoints, document each with parameters and schemas, and produce an OpenAPI spec.

About

Guides comprehensive API documentation by inventorying endpoints and documenting methods, parameters, request/response schemas, and examples into an OpenAPI spec. A developer uses it when documenting API endpoints.

Groups endpoints by resource and documents auth, parameters, and error responses
Produces an OpenAPI spec with info, servers, and security schemes

Api Docs by the numbers

1 all-time installs (skills.sh)
Ranked #1,366 of 1,879 Documentation skills by installs in the Skillselion catalog
Data as of Jul 22, 2026 (Skillselion catalog sync)

npx skills add https://github.com/girijashankarj/cursor-handbook --skill api-docs

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

[![Listed on Skillselion](https://skillselion.com/badge/skills/girijashankarj/cursor-handbook/api-docs.svg)](https://skillselion.com/skills/girijashankarj/cursor-handbook/api-docs)

Installs	1
repo stars	★ 27
Last updated	April 25, 2026
Repository	girijashankarj/cursor-handbook ↗

What it does

Workflow for creating comprehensive API documentation: inventory endpoints, document each with parameters and schemas, and produce an OpenAPI spec.

Files

SKILL.mdMarkdownGitHub ↗

Skill: Create API Documentation

Trigger

When the user needs to document API endpoints.

Prerequisites

[ ] API endpoints exist or are designed
[ ] OpenAPI/Swagger tooling available (optional)
[ ] Access to route definitions or handler files

Steps

Step 1: Inventory Endpoints

[ ] List all API endpoints
[ ] Group by resource/entity
[ ] Note HTTP method and path for each

Step 2: Document Each Endpoint

For each endpoint:

[ ] HTTP method and URL
[ ] Description and purpose
[ ] Authentication requirements
[ ] Request parameters (path, query, header)
[ ] Request body schema
[ ] Response schemas (success + errors)
[ ] Example request and response
[ ] Rate limiting details

Step 3: Create OpenAPI Spec

[ ] Define info, servers, security schemes
[ ] Create component schemas (reusable)
[ ] Define paths with all operations
[ ] Add examples for all schemas
[ ] Validate spec

Step 4: Generate Documentation

[ ] Use Swagger UI or Redoc for interactive docs
[ ] Host at /api/docs or similar
[ ] Include in CI/CD for auto-updates

Step 5: Review

[ ] All endpoints documented
[ ] Examples are accurate and working
[ ] Error responses documented
[ ] Authentication flow documented

Completion Checklist

[ ] All endpoints have method, URL, params, body, response
[ ] Error responses (4xx, 5xx) documented
[ ] Examples validated against live API or schema
[ ] OpenAPI spec validates (if used)

If Step Fails

Step 1 (inventory): Search for route definitions: **/*.route*.ts, **/routes/**, app.get|post|put|delete
Step 3 (OpenAPI): Use minimal spec first; add complexity incrementally. Validate with swagger-cli validate
Step 4 (generate): Swagger UI needs valid spec; Redoc is more forgiving. Check CORS if hosted separately

Example

Step 2 for POST /api/v1/orders: Method POST, URL /api/v1/orders, Body { customerId, items: [{ productId, quantity }] }, Response 201 { data: { id, status } }, Errors 400 validation, 404 customer not found.