#301 · Herramienta para desarrolladores

REST Endpoint Table Builder

Organiza inventarios de endpoints REST escritos como líneas de texto y genera una tabla Markdown lista para documentación. Cada línea puede usar el formato `MÉTODO URL - descripción`; también se aceptan rutas sin descripción. El analizador normaliza el método, conserva la ruta original y marca entradas que no contienen un verbo HTTP reconocido. El resultado incluye recuentos por método y avisos de líneas omitidas, lo que ayuda a revisar rápidamente especificaciones copiadas desde notas, tickets o documentación interna.

Datos de entrada

Listado de endpoints
Espacio publicitario

Cómo usar esta herramienta para desarrolladores

  1. Pega una línea por endpoint con método y ruta.
  2. Añade una descripción después de un guion, dos puntos o raya si la necesitas.
  3. Pulsa «Construir tabla» o usa Ctrl/Cmd + Enter.
  4. Revisa las líneas omitidas y copia o descarga la tabla Markdown.

Qué hace esta herramienta para desarrolladores

Interpreta cada línea como un endpoint REST y produce una tabla homogénea para README, documentación técnica o revisiones de API.

El primer token debe ser un método HTTP conocido; el segundo es la ruta o URL. El resto, tras un separador, se usa como descripción.

No valida que el endpoint exista ni realiza solicitudes de red. La herramienta trabaja únicamente con el texto proporcionado.

Ejemplo

Entrada

GET /api/users - Lista usuarios
POST /api/users - Crea un usuario
DELETE /api/users/{id} - Elimina un usuario

Salida esperada

| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/users | Lista usuarios |
| POST | /api/users | Crea un usuario |
| DELETE | /api/users/{id} | Elimina un usuario |

Casos de uso

  • Convertir notas de diseño de API en una tabla para un README.
  • Revisar rápidamente qué métodos HTTP aparecen en una especificación informal.
  • Preparar inventarios de rutas para una migración o auditoría.
  • Detectar líneas que no siguen el patrón básico método + URL.

Consejos para obtener resultados fiables

  • Usa una línea por endpoint para evitar ambigüedades.
  • Incluye parámetros de ruta tal como se usan en el proyecto.
  • No mezcles ejemplos de respuesta en la misma línea del endpoint.
  • Revisa las líneas omitidas antes de publicar la tabla.
  • Conserva descripciones cortas y orientadas a la acción.

Detalles del procesamiento

El parser recorre las líneas, reconoce verbos HTTP estándar y conserva las rutas sin reescribirlas. También genera un objeto JSON con los endpoints y un recuento por método.

No interpreta OpenAPI, Swagger ni sintaxis de frameworks. Tampoco comprueba autenticación, códigos de estado ni disponibilidad del servidor.

Preguntas frecuentes

¿Qué formato debe tener una línea para convertirla en endpoint REST?

Usa `MÉTODO URL` y, de forma opcional, añade una descripción después de `-`, `—` o `:`.

¿El constructor acepta rutas relativas como /api/users/{id}?

Sí. La ruta se conserva literalmente y no necesita incluir dominio ni protocolo.

¿Qué ocurre si escribo un método HTTP desconocido?

La línea se contabiliza como omitida y no aparece en la tabla generada.

¿La tabla verifica que los endpoints respondan correctamente?

No. No se realizan solicitudes de red; solo se transforma el texto introducido.

¿Puedo exportar el inventario de endpoints además de Markdown?

Sí. La interfaz habilita exportaciones CSV y JSON con los endpoints reconocidos.

Módulos de la herramienta

MóduloComportamiento
Parser de líneasReconoce método, ruta y descripción.
Tabla MarkdownEscapa barras verticales para mantener columnas válidas.
Resumen JSONIncluye endpoints, recuentos por método y líneas omitidas.

Explorar la categoría

Consulta más utilidades de API y GraphQL en el hub de la categoría.

Ver API y GraphQL