Genera OpenAPI 3.0 para hacer ingeniería inversa de APIs REST en unos pocos clics
Esta es la lista de lo que conseguiremos al final de este tutorial:
- Configurar Proxyman en tu Mac
- Capturar solicitudes y respuestas desde tu navegador web o una app de iPhone
- Generar OpenAPI 3.0 como archivos YAML o como documentación HTML.
Video de demostración:
- Haz clic para reproducir:
Requisitos previos
- Descarga la versión actual de Proxyman para macOS. La exportación a OpenAPI está incluida en la app normal, así que ya no es necesaria la compilación beta antigua.
Capturar tráfico HTTPS desde macOS
Antes de empezar, asegúrate de tener Proxyman instalado en tu Mac y de confiar en el certificado de Proxyman en tu Mac.
Si eres nuevo en Proxyman, sigue la Guía de inicio para macOS, que te ayudará a configurar tu Mac.
Por último, prueba a abrir www.producthunt.com o cualquier otro sitio web en tu navegador y captura el tráfico. Proxyman ya puede capturar y descifrar el tráfico HTTPS de tu navegador.
Capturar tráfico HTTPS desde iPhone
Para capturar tráfico HTTPS desde un iPhone, debes seguir la guía de configuración para dispositivos iOS físicos. Sigue la guía de configuración para dispositivos iOS físicos para configurar tu iPhone.
Una vez configurado, podrás capturar tráfico HTTPS desde tu iPhone.
Generar OpenAPI 3.0 YAML
Generar OpenAPI 3.0 YAML desde Proxyman es muy sencillo.
- Selecciona la solicitud y la respuesta a partir de las que quieres generar el OpenAPI 3.0 YAML.
- Haz clic derecho → Export → OpenAPI → YAML
- Elige dónde guardar el archivo.
- Listo
Así se ve el archivo YAML al abrirlo en Swagger Editor
Generar documentación HTML de OpenAPI 3.0
En lugar de YAML, puedes seleccionar HTML para generar la documentación HTML de OpenAPI 3.0.
Conclusión
Proxyman es una herramienta potente que te ayuda a capturar e inspeccionar el tráfico HTTP/HTTPS de tu navegador o de tu app móvil. Gracias a la posibilidad de generar OpenAPI 3.0 en YAML o como documentación HTML, ahora puedes compartir fácilmente la documentación de tu API con tu equipo o tus clientes.
Trata el archivo generado como un buen punto de partida, no como un contrato terminado. Captura más de un ejemplo para los endpoints con campos opcionales y revisa los tipos de parámetros, los valores obligatorios, las respuestas de error, la autenticación y los datos de ejemplo privados antes de publicarlo. Una muestra de tráfico real puede mostrar lo que ocurrió una vez, pero no puede describir todas las respuestas que el servidor podría devolver.
¿Qué sigue?
- Lee la especificación de OpenAPI 3.0: Especificación de OpenAPI
- Lee más sobre Proxyman: Documentación de Proxyman
- Documentación de exportación a OpenAPI: Documentación de exportación a OpenAPI
