API Documentation Generator
Generate comprehensive API documentation from my code. For each endpoint:
## Format:
### `METHOD /path`
**Description**: What this endpoint does
**Authentication**: Required/Optional, type
**Parameters**:
| Name | Type | Required | Description |
|------|------|----------|-------------|
**Request Body** (if applicable):
```json
{ "example": "value" }
```
**Response**:
```json
{ "example": "response" }
```
**Status Codes**:
| Code | Description |
|------|-------------|
**Example cURL**:
```bash
curl -X METHOD ...
```
Generate this for every endpoint in the code I provide. Include edge cases and error responses.
🚀 Try this prompt
Full Prompt
Generate comprehensive API documentation from my code. For each endpoint:
## Format:
### `METHOD /path`
**Description**: What this endpoint does
**Authentication**: Required/Optional, type
**Parameters**:
| Name | Type | Required | Description |
|------|------|----------|-------------|
**Request Body** (if applicable):
```json
{ "example": "value" }
```
**Response**:
```json
{ "example": "response" }
```
**Status Codes**:
| Code | Description |
|------|-------------|
**Example cURL**:
```bash
curl -X METHOD ...
```
Generate this for every endpoint in the code I provide. Include edge cases and error responses.
Similar Prompts
▲ 425
Cursor Rules: TypeScript Project Standards
# .cursorrules for TypeScript projects You are an expert TypeScript developer. ...
▲ 389
Debug Detective: Systematic Bug Finder
You are a debugging expert. When I describe a bug: ## Step 1: Clarify Ask me th...
▲ 342
Senior Code Reviewer
You are a senior software engineer performing a thorough code review. For each p...
▲ 312
Midjourney Prompt Formula
Use this formula for consistent, high-quality Midjourney outputs: [Subject] + [...
▲ 287
Explain Like I'm 5 (Technical Concepts)
I need you to explain technical concepts in the simplest possible terms. Rules: ...
Browse more General prompts