1

    API Docs Writer — Generate Clear, Accurate API Reference from Your Code or OpenAPI Spec

    by PubsProToolkit

    Generate consistent API reference docs from your code, OpenAPI spec, or route handlers — per-endpoint parameters, real request and response examples, error codes, auth, and copy-pasteable curl, written for the developer calling the API.

    Updated Jun 2026
    Security scanned
    dependencies

    $9

    · or 45 credits

    30-day refund guarantee

    Secure checkout via Stripe

    Also available in a bundle

    Included in download

    • Generate consistent Markdown reference docs from Express or FastAPI routes.
    • Extract table-based parameter lists and schemas from OpenAPI specifications.
    • file_read, file_write automation included
    • Ready for dependencies
    • Instant install

    See it in action

    You say

    Generate documentation for this Express route: router.post('/v1/billing/subscribe', auth, validate(schema), (req, res) => { ... }); The schema requires a plan_id string and email.

    Your agent does

    POST /v1/billing/subscribe

    Creates a new subscription for a customer.

    Authentication Bearer token required.

    Request body | Field | Type | Required | Description | | --- | --- | --- | --- | | plan_id | string | yes | ID of the plan to subscribe to | | email | string | yes | Customer email address |

    Example:

    { "plan_id": "pro_monthly", "email": "jane@example.com" }
    

    Responses

    • 201 Created: Subscription initialized.
    { "id": "sub_8f2", "plan_id": "pro_monthly", "status": "active" }
    
    • 400 Bad Request: Validation failed for plan_id or email.
    • 401 Unauthorized: Missing or invalid bearer token.

    Example request

    curl -X POST https://api.example.com/v1/billing/subscribe \
      -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type: application/json" \
      -d '{ "plan_id": "pro_monthly", "email": "jane@example.com" }'
    

    About This Skill

    API reference is the documentation developers most need and most hate writing, so it ends up missing, stale, or written for the person who built the API instead of the person calling it. API Docs Writer generates reference docs the consumer can actually use. Point it at route or controller code, an OpenAPI/Swagger spec, or schema definitions, and it documents each endpoint the same way — method and path, required auth, path and query parameters, the request body with a realistic example, the response shape with a real example and status code, the error codes it actually returns and what triggers each, and a copy-pasteable curl call. It opens with the base URL, auth model, and shared conventions so they are not repeated per endpoint, writes for the caller rather than the author, and never invents endpoints or behavior that are not in your source — marking unknowns as TODO. Content-only, no install. Works with Claude Code, Cursor, Codex CLI, Gemini CLI, and any SKILL.md agent.

    Use Cases

    • Generate consistent Markdown reference docs from Express or FastAPI routes.
    • Extract table-based parameter lists and schemas from OpenAPI specifications.
    • Create realistic curl examples and JSON payloads for API consumers.
    • Document HTTP error codes and authentication requirements per endpoint.

    Reviews

    No reviews yet - be the first to share your experience.

    Only users who have downloaded or purchased this skill can leave a review.

    Security Scanned

    Passed automated security review

    Permissions

    Read Files
    Write Files

    File Scopes

    **/*.md
    **/*.{ts,js,py,go,rb,java}
    **/*.{json,yaml,yml}

    This is a content-only SKILL.md skill. It reads source code, OpenAPI/Swagger specs, and schema files to extract endpoint details, and writes Markdown reference documentation. It does not run shell commands, open a browser, make network calls, or read environment variables.

    Content-only SKILL.md skill — no install, dependencies, or runtime. Works with any SKILL.md-compatible agent, including Claude Code, Cursor, Codex CLI, Gemini CLI, and VS Code Copilot. The agent needs read access to your source (code, OpenAPI/Swagger spec, or schemas) and write access to save the generated Markdown.

    Creator

    PubsProToolkit builds rigor-first skills for AI agents — they write your docs and content properly, then adversarially review them to catch what's wrong before it ships. The result: cleaner output and a hard quality gate in one toolkit. Built by a CMPP-certified, PhD medical writer who brings regulated-industry standards to developer docs, content, compliance, and research integrity.

    Frequently Asked Questions

    More Premium Skills

    $9