api - lista - seo html tags list
Creando documentos html de la colección de carteros (4)
He desarrollado una API bastante extensa, y la tengo en Postman, que funciona bastante bien. Ahora tengo que generar un documento html para mantenerlo versionado dentro de / docs junto con mis fuentes.
¿Hay una herramienta o una manera de lograr esto? Realmente no quiero escribir toda esta documentación. Compartir la colección de carteros no es una opción.
Hace poco tuve el mismo problema y no encontré nada. Así que creé una herramienta simple para hacerlo. Es una aplicación javascript muy básica escrita con react.js. En este momento es muy básico, pero estoy trabajando en ello, por lo que cualquier solicitud de función es bienvenida.
Puede usarlo gratis en: http://www.vernizzis.it/docman/
Además, puede obtener el código y modificarlo en: https://github.com/davidevernizzi/docman
Cualquier comentario es más que bienvenido.
ACTUALIZACIÓN1: mirando a mi alrededor también encontré este proyecto: https://github.com/JakeWorrell/docodile y esta solicitud de función: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
ACTUALIZACIÓN2: la solicitud de función (ver ACTUALIZACIÓN1) se ha cerrado y la posibilidad de crear documentación se ha agregado a la nube de Postman. Aquí está el comentario de cierre de solicitud de función:
Esto está disponible como parte de Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/ . La nube aloja, actualiza y mantiene la documentación para todos. Yo sugeriría http://docman.launchrock.com/ y https://github.com/JakeWorrell/docodile para generar documentación única de Colecciones.
Puede instalar Newman usando el comando "npm install -g Newman" y luego ejecutar el comando "newman ejecutar CollectionName.json -e envVar.json" desde la ubicación donde guardó su colección, donde CollectionName.json es su nombre de colección y enVar .json es el conjunto de variables de entorno. Esto generará un informe html en la misma carpeta. Un requisito previo es tener el nodo js instalado.
Sé que esta es una pregunta antigua y que probablemente ya haya encontrado una solución, pero aún así puede interesarle Postmanerator: https://github.com/aubm/postmanerator
Básicamente, así es como lo usas desde la línea de comando:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Para instalarlo, descargue la última versión de Github. Necesitas elegir el binario apropiado dependiendo de tu sistema. Luego colóquelo en algún lugar de su RUTA.
Consulte la documentación en el archivo README si desea información adicional. A partir de ahí, encontrará recomendaciones para aprovechar al máximo la herramienta o cambiar el aspecto de su documentación mediante el uso de temas personalizados.
La presentación de Github también proporciona una referencia a una documentación de ejemplo generada.
También descubrirá cómo puede aprovechar una plataforma de CI como Travis, para automatizar la generación y la publicación de su documentación con Postmanerator.
Dado que este es un proyecto de código abierto en el que estoy trabajando, no dude en enviar problemas en Github si tiene alguna idea que lo pueda mejorar.
También puedes probar la herramienta gratuita que hice. Proporciona la documentación en .txt, pero puede convertirla a pdf usando su navegador.