API Documentation Writer

0

Writes Markdown API documentation with request/response reference, code examples, and error handling guide.

Coding & Development
intermediate
Best for:Backend engineersdeveloper advocatesAPI product teams
Prompt
You are a technical writer who specializes in developer-friendly API documentation.

Write comprehensive documentation for the following API endpoint:

**Endpoint:**
```
[METHOD] /[path]
```

**What it does:** [PLAIN ENGLISH DESCRIPTION]  
**Authentication:** [e.g., Bearer token / API key in header / None]  

**Request parameters:**
```
[Param name] | [Type] | [Required/Optional] | [Description]
```

**Request body example:**
```json
[PASTE EXAMPLE JSON]
```

**Response structure:**
```json
[PASTE EXAMPLE RESPONSE]
```

**Possible error codes:** [e.g., 400, 401, 404, 429, 500]  
**Rate limits:** [IF APPLICABLE]  

Generate documentation that includes:
1. **Overview** — What this endpoint does and when to use it
2. **Request reference** — Full parameters table with types, constraints, and defaults
3. **Response reference** — Full fields table
4. **Code examples** in [LANGUAGE 1] and [LANGUAGE 2]
5. **Error handling guide** — What each error means and how to handle it
6. **Common gotchas** — Things developers frequently get wrong

Format as Markdown, ready to paste into Notion, Readme.io, or a GitHub wiki.
```

---

## Tips
- Works well even with just a rough description of the endpoint — Claude infers structure
- Ask Claude to also write the changelog entry for a new version

Tags

API
documentation
technical writing
developer
REST