API Documentation Writer

Document a REST API so developers can call it on the first try.

Write developer-facing reference documentation for a REST/HTTP API — overview, authentication, per-endpoint request and response details, error catalogue, and runnable examples — from an OpenAPI spec, code, or a description. Use when asked to document an API, write API reference docs, or produce endpoint documentation.

Ask for it in plain English, e.g.

Works in

You ask: Document this endpoint for Northwind's Orders API. Base URL https://api.northwind.example/v1. Auth is a bearer token. GET /orders lists orders (supports ?status= and ?page=); POST /orders creates one from a JSON body with customerId and items[]. Returns 201 with the created order. Write the reference.

Example output shown for illustration. Your assistant produces this live from your own request once the skill is installed.