Agregar ejemplos de responses y descripción de endpoints

Documenta!.. Tu “yo” del futuro te lo agradecerá.

Les comparto dos recursos que encontre sobre markdown:

Una buena práctica es documentar directamente en el API, por ejemplo utilizando Swagger.

Qué les pareció la clase?

Los ejemplos de responses también sirven para generar un mock server. Escribe sobre como crearlos en un tutorial.

https://platzi.com/tutoriales/1765-postman/4882-creando-mock-server-con-postman/

¿Para que el OPTIONS funcione, desde la programación de la API debe hacerse un tipo de respuesta?

😃

Este sitio les puede ayudar a crear una documentación con Markdown
https://pandao.github.io/editor.md/en.html

esta opción de documentación está buenísima

Concuerdo con mi compañero, swagger tiene una versión gratis y permite documentar directamente sobre el API. Dejo el link:
https://swagger.io/

Cuando empezamos a construir el API de un proyecto no somos consientes de la importancia de hacer este tipo de practicas hasta que llegamos a un pulpo gigantes y debemos documentar, un ingeniero organizado es un proyecto más efectivo, más económico y construye software de fácil mantenimiento.

Excelente aporte de esta clase, eso de documentar da weba, pero hay que hacerlo!!

Fue un largo camino pero creo que ya están guardados y documentados los request del curso.

Genial, Postman te permite hacer documentación de los endpoints guardando ejemplos de respuestas y añadiendo una descripción en formato Markdown, me gustaría hacer estas prácticas pero la API no funcionó:(

La documentacion es importante para el desarrollo!!

Excelente…

Por fin empiezan las clases útiles

cómo va Mi proyecto , en postman

gracias Platzi

muy bueno

Excelente…

12/12/20, tuve que guardar primero el end-point para poder hacer el save response -> as example.

Excelente clase! muy buena forma de ir documentando la API

Muy funcional este toolkit que apoya la documentación de las API´s en su fase de pruebas.

Esta forma la veo muy buena para documentar. 😄

Ya documente los request vistos en clase:

Al fin, 2 videos buenos, este y el anterior. Si borran del anterior video al inicio la gente ahorrara su tiempo.

Saludos.

Recomiendo nombrar sus requests en infinitivo, como Crear comentario o Create comment, Delete course, etc. Es buena práctica, se vuelve más concreto y no pierde lo descriptivo.

Igual para nombrar los ejemplos, Create comment succesfully

Excelente, no sabia que postman permitia documentacion

Viniendo de los nuevos cursos de API REST de Laravel y viendo las nuevas actualizaciones de la interfaz de Postman, que hermoso son ven las peticiones con sus respectivos ejemplos ❤️. Postman una herramienta sumamente útil.

Hay forma de crear mock services en postman?

cd