API Documentation Builder

Prompt

Generate OpenAPI 3.0 documentation for this API endpoint:
Method: [GET/POST/etc.]
Path: [/path]
Function: [what it does]

Include: description, parameters (with types, constraints, examples), request body schema, all response codes (200, 400, 401, 404, 500) with example payloads, authentication requirements, rate limits, and 3 curl example calls. Follow REST best practices.

How to use this prompt

1. 1

   Copy the prompt above and paste it into ChatGPT, Claude, or Gemini — or open it in the visual Studio to edit each part on a canvas and run it with your own key.

2. 2

   Replace any bracketed placeholders with your specifics. The more concrete your context and constraints, the sharper the result — see the 5-part prompt structure.

3. 3

   Run it, then refine. Ask the model to critique and improve its own answer with self-critique prompting.

Techniques in this prompt

Recommended models