#407 · Markdown y documentos

Formateador de descripciones de API

Convierte descripciones dispersas de endpoints en una ficha técnica ordenada. Detecta método HTTP y ruta cuando aparecen en el texto, separa líneas útiles y genera una presentación uniforme para documentación interna o pública.

Entrada de texto

Descripción de API
Espacio publicitario

Cómo usar esta herramienta de texto

  1. Pega o escribe el contenido en el área de entrada.
  2. Ajusta las opciones disponibles si necesitas cambiar el comportamiento.
  3. Pulsa el botón principal o usa Ctrl/Cmd + Enter.
  4. Revisa el resumen, las métricas y el resultado antes de copiarlo o descargarlo.

Qué hace esta herramienta

Procesa el contenido con reglas específicas del formato y genera una salida más estructurada o un análisis cuantificable.

El texto se divide en líneas, se reconocen patrones propios del formato y se reconstruye una salida consistente sin modificar identificadores técnicos.

El resultado se genera en tu navegador. Revisa siempre el contenido antes de publicarlo o usarlo en producción.

Ejemplo

Entrada:

GET /users/{id}
Devuelve el usuario por ID.
Parámetro: id obligatorio
Respuesta: objeto JSON del usuario

Resultado: ejecuta el ejemplo incorporado para ver una salida verificable con las mismas reglas del procesador.

Casos de uso

  • Revisión rápida antes de publicar documentación.
  • Normalización de contenido pegado desde distintas fuentes.
  • Comprobación local sin depender de servicios externos.

Consejos para obtener mejores resultados

  • Usa una entrada suficientemente representativa.
  • Conserva una copia del original antes de reemplazar contenido.
  • Revisa nombres propios, código y valores sensibles tras el procesamiento.
  • Prueba casos límite si el resultado se integrará en un flujo automatizado.

Detalles del procesamiento

El procesamiento se ejecuta localmente con JavaScript y opera sobre el texto visible en el navegador. No requiere una API externa.

El análisis se basa en patrones y no sustituye un parser, compilador o detector especializado cuando se necesita validación normativa completa.

Preguntas frecuentes

¿Cómo extrae el método HTTP y la ruta de una descripción de API?

Busca métodos comunes como GET, POST, PUT, PATCH o DELETE y una ruta que comience por /. Si los encuentra, los coloca en campos separados.

¿Qué ocurre si mi descripción no incluye un método HTTP?

El resultado indica que el método no fue detectado y conserva el resto de las líneas como descripción.

¿Puede formatear rutas con parámetros como /users/{id}?

Sí. El patrón admite llaves y caracteres habituales de rutas y consultas.

¿La herramienta valida parámetros o respuestas contra OpenAPI?

No. Estructura texto libre; no carga ni valida una especificación OpenAPI.

¿Puedo reutilizar el resultado en documentación interna?

Sí. La salida separa método, ruta y descripción, lo que facilita copiarla a wikis, tickets o referencias de API.

Resumen de módulos

MóduloFunción
EntradaTexto pegado, escrito o cargado desde archivo
ProcesamientoReglas específicas del tipo de herramienta
SalidaResultado copiable y descargable