BestPromptFinder

API Documentation Written From Your Code

Quality, usefulness and confidence are AI evaluations out of 100 — not user ratings. Community results come from visitors' "worked / didn't work" votes below. How scoring works →

The prompt

Write clear API documentation from my code. Code: [paste route handlers, controllers or an OpenAPI file] Auth: [API key / bearer token / session cookie] Base URL: [placeholder is fine] Audience: [internal team / external developers / a mobile app team] For each endpoint, document: - Method and path - What it does, in one sentence - Auth required - Path, query and body parameters: name, type, required or optional, rules, example - A sample request (curl) and a sample success response - Error responses with status codes and what causes each - Rate limits or pagination, only if the code shows them Then add: 1. A getting-started section: authenticate and make a first call in three steps. 2. A list of things the code does that look like bugs or inconsistencies (e.g. a field that's required in one place and optional in another). 3. An OpenAPI 3 YAML draft if I didn't give you one. Rules: document only what the code does; mark anything you inferred [CHECK]; use fake example values, never real keys or user data.

Why this prompt

• Hand-picked, editorially reviewed prompt
• Written for Claude, ChatGPT, Gemini

Source

Created by BestPromptFinder — editorial prompt, not user-generated. See our content & source policy.

Related Coding prompts