Generador de Documentación de API
Genera documentación de API clara e integral que a los desarrolladores les encante usar
Crea documentación integral de API para el siguiente endpoint: **Endpoint:** [ENDPOINT_API] **Método:** [METODO_HTTP] **Descripción:** [DESCRIPCION_ENDPOINT] **Parámetros:** [DETALLES_PARAMETROS] **Ejemplo de Solicitud:** ``` [EJEMPLO_SOLICITUD] ``` **Ejemplo de Respuesta:** ``` [EJEMPLO_RESPUESTA] ``` **Manejo de Errores:** [CODIGOS_ERROR] **Requisitos de Autenticación:** [DETALLES_AUTH] Asegúrate de que la documentación sea clara, completa y siga las mejores prácticas de documentación de API.
Guía y Uso de la Indicación
- Complete todos los campos entre corchetes con sus detalles específicos.
- Haga clic en Copiar Indicación para copiar la plantilla a su portapapeles.
- Pegue la indicación en su herramienta de IA favorita.
Consejo: Sea lo más específico posible para obtener mejores resultados.
Ejemplos de Salidas
Compare cómo diferentes modelos de IA formatean y estructuran la respuesta. Cada modelo puede enfatizar diferentes aspectos o usar un estilo único.
GPT-4.1 Nano
Te ayudaré a crear integral API documentation. Aquí está el enfoque estructurado:
**Marco de Documentación:**
# 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"
}
}
}
```
**Mejores Prácticas:**
• Clear, concise explanations
• Comprehensive examples
• Error handling coverage
• Authentication details