---
name: api-documentation-writer
description: "Generate clean, standard API documentation from your code or endpoints. Use when the user wants help with API Documentation Writer. Related topics: coding, api, documentation."
---

# API Documentation Writer

Generate clean, standard API documentation from your code or endpoints.

## How to use this skill

1. Ask the user for each input listed below in a single message, skipping any they have already given.
2. Where options are listed, offer them, but accept other answers too.
3. Fill the answers into the prompt template, then follow the completed prompt to produce the result.

## Inputs

- **API Endpoint URL** (free text, e.g. "")
- **Description of what it does** (longer free text)
- **Authentication Required** (choose one: None, Bearer Token, API Key, Basic Auth)
- **Request Body Format** (choose one: JSON, Form-Data, Query Params)
- **Paste example request payload** (longer free text)
- **Paste example success response** (longer free text)
- **Include Error Codes/Responses?** (choose any: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Server Error)

## Prompt template

## Introduction
Create beautiful Markdown documentation for your API endpoints.

## Endpoint Details
- API Endpoint URL: {{API Endpoint URL}}
- Description of what it does: {{Description of what it does}}
- Authentication Required: {{Authentication Required}}

## Request & Response
- Request Body Format: {{Request Body Format}}
- Paste example request payload: {{Paste example request payload}}
- Paste example success response: {{Paste example success response}}
- Include Error Codes/Responses? {{Include Error Codes/Responses?}}

---
**Goal**: Produce a comprehensive API doc section including cURL examples and parameter tables.

---

Source: [API Documentation Writer on PromptBuild](https://promptbuild.io/prompt/1cSddjegskLx19nUTftN/api-documentation-writer)