Document any REST endpoint in seconds
Good API documentation answers four questions for the next developer: what the endpoint does, how to call it, what to send, and what comes back. This builder turns a few inputs into a complete, consistently formatted Markdown reference for a single endpoint so your docs stay uniform across an entire API surface.
How it works
The builder assembles a standard reference layout from your inputs. The method and path become a heading like GET /v1/users/{id}. Each parameter line you enter is split on the first comma into a name, type, and description and rendered as a row in a Markdown table. Request and response JSON examples are wrapped in fenced ```json blocks so they render with syntax highlighting. Response codes are listed with their meaning so consumers know how to handle success and error cases.
The output mirrors the field names used by the OpenAPI specification (path, query, requestBody, responses), which makes it straightforward to later migrate a Markdown reference into a formal OpenAPI document without restructuring your content.
Tips and example
- Use one parameter per line in
name, type, descriptionformat. For example:id, integer, The unique user identifier. - Always document at least one error response (such as
400or404) alongside the success code so callers can build proper error handling. - Keep the endpoint description to a single sentence that starts with a verb, e.g. “Returns a paginated list of orders for the authenticated user.”
- For consistency across a large API, copy this output into each route file and keep the same section order everywhere.