← Prompt library
CodingFree→ Claude / ChatGPT

API Documentation Writer

Turn an endpoint definition into clear reference docs.

What you get: A reference doc: description, params table, example request/response, and error codes.

input
output — Claude / ChatGPT
Write reference documentation for this API endpoint: {{method}} {{path}}.

Include: a one-sentence description, a parameters table (name, type, required, description), an example request and response body, and the possible error status codes with what causes each.

Endpoint details:
{{endpoint_details}}