API Documentation Generator

Generate clear, comprehensive API documentation that developers love to use

Create comprehensive API documentation for the following endpoint:

**Endpoint:** [API_ENDPOINT]
**Method:** [HTTP_METHOD]
**Description:** [ENDPOINT_DESCRIPTION]

**Parameters:**
[PARAMETER_DETAILS]

**Request Example:**
```
[REQUEST_EXAMPLE]
```

**Response Example:**
```
[RESPONSE_EXAMPLE]
```

**Error Handling:**
[ERROR_CODES]

**Authentication Requirements:**
[AUTH_DETAILS]

Ensure the documentation is clear, complete, and follows API documentation best practices.

Prompt Guide & Usage

Fill in all bracketed fields with your specific details.
Click Copy Prompt to copy the template to your clipboard.
Paste the prompt into your favorite AI tool.

Tip: Be as specific as possible for best results.

Example Outputs

Compare how different AI models format and structure the response. Each model may emphasize different aspects or use unique styling.

GPT-4.1 Nano

I'll help you create comprehensive API documentation. Here's the structured approach:

**Documentation Framework:**
# User Authentication Endpoint

## POST /api/v1/auth/login

Authenticates a user and returns an access token for subsequent API requests.

### Request Parameters

| Parameter | Type   | Required | Description |
|-----------|--------|----------|-------------|
| email     | string | Yes      | User's email address |
| password  | string | Yes      | User's password |
| remember  | boolean| No       | Extend token expiration |

### Request Example

```json
{
  "email": "user@example.com",
  "password": "securepassword123",
  "remember": false
}
```

### Success Response (200)

```json
{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "user": {
      "id": 123,
      "email": "user@example.com",
      "name": "John Doe"
    }
  }
}
```

**Best Practices:**
• Clear, concise explanations
• Comprehensive examples
• Error handling coverage
• Authentication details

Claude Sonnet 4

I'll help you create comprehensive API documentation. Here's the structured approach:

**Documentation Framework:**
# User Authentication Endpoint

## POST /api/v1/auth/login

Authenticates a user and returns an access token for subsequent API requests.

### Request Parameters

| Parameter | Type   | Required | Description |
|-----------|--------|----------|-------------|
| email     | string | Yes      | User's email address |
| password  | string | Yes      | User's password |
| remember  | boolean| No       | Extend token expiration |

### Request Example

```json
{
  "email": "user@example.com",
  "password": "securepassword123",
  "remember": false
}
```

### Success Response (200)

```json
{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "user": {
      "id": 123,
      "email": "user@example.com",
      "name": "John Doe"
    }
  }
}
```

**Best Practices:**
• Clear, concise explanations
• Comprehensive examples
• Error handling coverage
• Authentication details

Gemini 2.5 Pro

I'll help you create comprehensive API documentation. Here's the structured approach:

**Documentation Framework:**
# User Authentication Endpoint

## POST /api/v1/auth/login

Authenticates a user and returns an access token for subsequent API requests.

### Request Parameters

| Parameter | Type   | Required | Description |
|-----------|--------|----------|-------------|
| email     | string | Yes      | User's email address |
| password  | string | Yes      | User's password |
| remember  | boolean| No       | Extend token expiration |

### Request Example

```json
{
  "email": "user@example.com",
  "password": "securepassword123",
  "remember": false
}
```

### Success Response (200)

```json
{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "user": {
      "id": 123,
      "email": "user@example.com",
      "name": "John Doe"
    }
  }
}
```

**Best Practices:**
• Clear, concise explanations
• Comprehensive examples
• Error handling coverage
• Authentication details