Plantilla de documentación de API

Plantilla profesional para documentar APIs REST con Markdown

Documentar una API correctamente es fundamental para que otros desarrolladores puedan integrarla. Esta plantilla te proporciona una estructura clara y completa.

Plantilla

# Nombre de la API

Breve descripción de la API y su propósito.

**URL base**: `https://api.ejemplo.com/v1`

## Autenticación

La API usa Bearer tokens para la autenticación:

\```
Authorization: Bearer tu-token-aqui
\```

## Endpoints

### Usuarios

#### Listar usuarios

\```
GET /users
\```

**Parámetros de consulta:**

| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| page | integer | No | Número de página (default: 1) |
| limit | integer | No | Resultados por página (default: 20) |

**Respuesta exitosa (200):**

\```json
{
  "data": [
    {
      "id": 1,
      "name": "Eduardo",
      "email": "eduardo@ejemplo.com"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20
  }
}
\```

#### Crear usuario

\```
POST /users
\```

**Cuerpo de la petición:**

\```json
{
  "name": "Eduardo",
  "email": "eduardo@ejemplo.com",
  "password": "contraseña-segura"
}
\```

**Respuesta exitosa (201):**

\```json
{
  "id": 1,
  "name": "Eduardo",
  "email": "eduardo@ejemplo.com",
  "created_at": "2024-01-15T10:30:00Z"
}
\```

## Códigos de error

| Código | Descripción |
|---|---|
| 400 | Petición incorrecta |
| 401 | No autenticado |
| 403 | Sin permisos |
| 404 | Recurso no encontrado |
| 422 | Error de validación |
| 429 | Demasiadas peticiones |
| 500 | Error del servidor |

## Límites de uso

- 100 peticiones por minuto por token
- Máximo 1000 resultados por consulta

Consejos para documentar APIs

Ten en cuenta estos consejos:

  • Incluye ejemplos reales: Muestra peticiones y respuestas completas.
  • Documenta los errores: No solo los casos exitosos.
  • Usa tablas para parámetros: Son más fáciles de escanear.
  • Mantén actualizada: La documentación debe reflejar el estado actual de la API.
  • Añade ejemplos con curl: Facilita las pruebas rápidas.

👋 Hola! Soy Edu, me encanta crear cosas y he redactado este tutorial. Si te ha resultado útil, el mayor favor que me podrías hacer es el de compatirlo en Twitter.

para estar al día con mi contenido. 😊