api documentation builder

    1

    Standardizes fragmented API specs, notes, and traffic into production-ready Markdown documentation.

    $5

    Secure checkout via Stripe

    30-day refund guarantee

    Converts to your local currency at checkout

    0 installsSecurity scanned

    Works with the AI tools you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIGitHub CopilotGitHub CopilotGemini CLIGemini CLI+20 more

    api documentation builder

    Example session with this skill installed

    I have a basic OpenAPI yaml and some notes on our custom rate limiting and webhook signatures. Can you build a full reference doc? The rate limits are 100 req/min based on the X-API-Key header.

    • Read your context and instructions
    • Compiled the api documentation builder

    I have reconciled your OpenAPI specification with the provided notes on rate limiting and webhooks. I prioritized the specific implementation details for the custom headers over the generic spec placeholders.

    API Reference Documentation

    SectionContent Summary
    Base URLhttps://api.acme-corp.com/v1
    AuthenticationAPI Key via X-API-Key header.
    Rate Limits100 requests per minute. Includes X-RateLimit-Remaining headers.
    EndpointsGET /users, POST /orders, GET /orders/{id}
    Webhooksorder.created, order.updated. Verified via HMAC-SHA256 signature.

    Authentication

    All requests must include the following header:
    X-API-Key: <your_api_key>

    Rate Limiting

    The API enforces a limit of 100 requests per sliding 60-second window per API key.

    • 429 Too Many Requests: Returned when limits are exceeded.
    • Headers:
      • X-RateLimit-Limit: 100
      • X-RateLimit-Remaining: Number of requests left in the current window.
      • Retry-After: Seconds to wait before next request.

    Endpoints

    POST /orders

    Creates a new order in the system.

    Request Body

    {
  "customer_id": "cust_99210",
  "items": [
    {
      "sku": "SKU-001",
      "quantity": 2
    }
  ]
}

    Response (201 Created)

    {
  "id": "ord_5521",
  "status": "pending",
  "created_at": "2023-10-27T10:00:00Z"
}

    Webhooks

    We send POST requests to your configured URL. You must verify the X-Hub-Signature header.

    Next steps

    1. Verify the HMAC signature logic in your listener matches the X-Hub-Signature description.
    2. Check the order.updated payload against your local database schema.
    3. Test the 429 response handling in your client's retry logic.

    Connects securely to your tools. The creator never sees your data.

    What you get

    Convert raw endpoint lists into structured Markdown reference guides.Audit documentation accuracy by comparing specs against live traffic samples.Standardize auth and pagination docs across multiple microservices.Identify and flag undocumented parameters or missing error codes.

    About this skill

    The problem

    Developers often struggle with fragmented API documentation, where specs, Slack notes, and code comments contradict each other. This lead to integration errors, broken schemas, and wasted hours chasing down the authoritative truth.

    What it does

    • Reconciles conflicting sources by prioritizing live traffic and spec files over informal notes.
    • Identifies undocumented parameters, missing response schemas, and logic gaps.
    • Generates structured Markdown references covering auth, pagination, webhooks, and rate limits.
    • Produces realistic, schema-validated request and response examples for every endpoint.
    • Audits existing documentation against actual implementation behavior.

    Frameworks & tools

    Compatible with OpenAPI (Swagger), RAML, GraphQL SDL, and raw HTTP traffic logs. Outputs standard GitHub-flavored Markdown.

    Why this beats prompting it yourself

    General-purpose prompts often hallucinate missing fields or mix up authentication and authorization logic. This skill follows a strict resolution hierarchy and a 10-point structural checklist to ensure no technical corner cases like rate-limit headers or pagination termination are ignored.

    Use cases

    • Consolidating scattered integration notes into a single developer portal.
    • Auditing a legacy API to see where the documentation has drifted from the code.
    • Building a complete reference for a new service from raw traffic samples.
    • Standardizing internal API docs for better cross-team developer experience.

    Known limitations

    Does not generate client SDKs, mock servers, or executable code. Requires source material or traffic samples to function.

    How to install

    Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.

    ~30 seconds
    1. 1

      Download the ZIP

      Free skills download straight away. Paid skills unlock right after purchase.

    2. 2

      Unzip into your skills folder

      Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.

    3. 3

      Ask your agent to use it

      Restart the agent if it was already running. It picks the skill up automatically - no config needed.

    Skills folder by agent

    Click the path to copy it. Create the folder if it does not exist yet.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill passes our trust checks below.

    Security scanned

    Passed our 8-point scan before listing

    Fresh listing

    Recently published to Agensi

    30-day refund

    Not a fit? Get your money back

    Trust & safety

    Security scanned

    Verified clean 9 days ago

    • Passed all security checks, Safe to install

    Listed9 days ago

    What's inside

    Frequently Asked Questions