Si queremos una documentación rápida y bonita de los endpoints de nuestro server, podemos hacer uso Postman. Lo primero será crear una colección para almacenar nuestras peticiones. Podemos ordenar mediante carpetas según la temática que queramos definir (por grupos de servicios, tipos de peticiones, etc.).
Es muy útil que le pongamos un nombre claro a la colección, directorios y peticiones. Luego, podemos presionar los 3 puntos al lado derecho de la colección, y seleccionamos View Documentation. Esto nos va a abrir una pestaña en la que podemos añadir descripciones o pequeñas modificaciones. Si queremos publicar la documentación, buscamos la opción de Publish (importante tener una sesión activa con alguna cuenta), lo que nos abrirá una ventana en el navegador para ultimar detalles, y una vez publicado los cambios, podemos obtener el link de la documentación en la web.
En el caso de este proyecto, la documentación se encuentra en este link: Documentación NodeJs MVC MySQL y MongoDB
| Anterior | Siguiente | |
|---|---|---|
| Archivos - Multer | Readme | Como validar datos en un API REST |