‫Narrador: Entonces, nuestra API ahora está básicamente terminada.
‫Entonces, en este video
‫final de la sección, crearemos
‫rápidamente documentación para API directamente en Postman.
‫Y así es, podemos
‫crear fácilmente documentación rápida directamente en Postman.
‫Y es realmente importante contar con la documentación
‫de la API porque así es como nos comunicamos con los miembros del
‫equipo, o incluso con nuestros usuarios finales de la API,
‫cómo pueden usarla en la práctica.
‫Déjame mostrarte cómo funciona.
‫Ahora, antes de que podamos crear la
‫documentación, hagamos una limpieza aquí.
‫Por ejemplo, deshazte de esta solicitud, ¿de acuerdo?
‫Otra cosa que quiero hacer es aquí en el punto de
‫inicio de sesión, de hecho exponemos nuestra contraseña aquí.
‫Y esa no es una buena idea, así que lo que voy
‫a hacer es crear una variable de entorno
‫que va a contener esta contraseña.
‫Dado que siempre es lo mismo, eso no debería ser un problema.
‫Entonces, recuerde cómo lo hacemos.
‫Bueno, venimos aquí a administrar el
‫medio ambiente y aquí simplemente agregamos otro.
‫Entonces contraseña, test1234.
‫Y aquí esto no es correcto, así que contraseña, actualizada, y ahora, hagamos
‫lo mismo aquí en
‫la producción también.
‫Entonces contraseña, test1234.
‫Y entonces, no agregar, pero cerremos eso y
‫aquí ahora puedo agregar y usar eso,
‫no en una cadena, sino así.
‫Entonces contraseña.
‫Así que intentemos eso.
‫Y esto nos da este extraño error, pero
‫nuestra contraseña está realmente aquí, así que
‫probablemente lo que tenemos que hacer es poner las comillas aquí.
‫Así que intentemos eso.
‫Y ahora, de hecho, hemos iniciado sesión con éxito.
‫Así que guárdalo ahora, ¿de acuerdo?
‫Y ahora lo que debemos hacer es crear una descripción
‫para todas y cada una de las solicitudes
‫que tenemos en nuestra colección.
‫Ahora, por supuesto, no voy
‫a hacer eso, solo lo ejemplificaré aquí con el primero.
‫¿Okey?
‫Así que vamos a cerrar
‫estos otros y ahora aquí podemos agregar una descripción.
‫Entonces, digamos, use este punto final
‫para crear un nuevo recorrido.
‫De acuerdo, y nuevamente, ahora debería hacer exactamente lo mismo para
‫todas sus solicitudes si su objetivo es realmente publicar
‫y compartir su API, ¿de acuerdo?
‫Entonces lo mismo se aplica a las carpetas, y
‫no a cambiar el nombre, sino a editar.
‫Y así, en cada
‫una de estas carpetas, también podemos agregar una descripción.
‫Entonces, digamos algo aleatorio como, puede
‫obtener todos los recorridos, crear
‫nuevos
‫y editar y eliminar recorridos.
‫También hay puntos finales especiales para algunos
‫requisitos especiales.
‫De acuerdo, una y otra vez, esto
‫es totalmente aleatorio y publicaría algo como esto para mi propia
‫API, pero aquí realmente solo queremos probar cómo funciona, ¿de acuerdo?
‫Como puede ver
‫aquí abajo, también puede usar Mark aquí, ¿de acuerdo?
‫Entonces, por ejemplo, para poner el
‫texto en negrita, puedes pensar que funciona así, sí,
‫parece que lo hace, y
‫sí, puedes hacer todo tipo de cosas aquí, ¿de acuerdo?
‫Probablemente también puedas
‫crear una descripción en Natours,
‫así que digamos que la API de Natours
‫contiene puntos finales para recorridos, usuarios y reseñas.
‫Y luego, nuevamente, un
‫montón de cosas, como si pudiera describir su proceso
‫de autenticación, o sus permisos y realmente todo lo
‫que el usuario necesita saber para usar esta API, ¿de acuerdo?
‫Por lo tanto, siempre
‫debe agregar una descripción a todas las solicitudes, a todas las
‫carpetas y también, por supuesto, a la colección en sí.
‫Ah, y de hecho podemos describir los parámetros de consulta en una
‫cadena de consulta, así que hagámoslo aquí.
‫Y también podemos decir que admite operadores
‫mayor que, menor que igual, mayor que y menor que.
‫Entonces, nuevamente, solo un ejemplo
‫aquí y guardémoslo ahora en la solicitud.
‫Y con esto, creo que deberíamos
‫estar listos para publicar la documentación de nuestra API.
‫Y para hacer eso, vayamos aquí a
‫la opción de colecciones, y luego aquí
‫abajo, publiquemos la documentación.
‫Entonces eso debería abrir una ventana del navegador, y
‫para mí lo hizo fuera de
‫mi pantalla, así que déjame verlo aquí.
‫Y ahora puedes elegir el entorno.
‫Entonces, aquí deberíamos tener una lista de nuestros entornos, que
‫por alguna razón no tenemos, eso es extraño, pero de todos modos,
‫no queríamos usar ningún entorno de todos modos, porque eso
‫reemplazaría nuestras variables de
‫entorno con sus valores reales, y no
‫queremos eso.
‫Por ejemplo, usamos la variable de entorno
‫en la contraseña, para que
‫luego en la documentación no sea realmente visible, ¿de acuerdo?
‫Por tanto, no queremos utilizar ningún entorno.
‫Ahora también podríamos usar un
‫dominio personalizado, pero eso es solo para usuarios pagos, ¿de acuerdo?
‫Luego, también podríamos cambiar todo el estilo de la
‫API para que coincida con los colores de su marca,
‫pero nuevamente, eso no es necesario en
‫este caso, por lo tanto, sigamos adelante y publíquelo.
‫Y ahora, esto es realmente público,
‫por lo que todos pueden ver su documentación ahora en esta URL.
‫Ahora, por alguna razón, realmente no actualizó todos los cambios que
‫hicimos antes, así que eso es un poco extraño.
‫Así que volvamos a Postman y veamos
‫qué está pasando.
‫Tal vez tenga que ver con esta cosa giratoria aquí, así que simplemente
‫saldré de Postman y lo abriré nuevamente.
‫Y esperemos que eso lo solucione.
‫Entonces, si ahora recargamos
‫aquí, entonces obtendremos todos nuestros cambios aquí.
‫Ya ves, la descripción que
‫agregamos para la colección Natours, ¿de acuerdo?
‫Luego, también la descripción de esta carpeta y
‫la descripción de esta solicitud.
‫Y finalmente, como la primera
‫descripción, también para este parámetro, ¿de acuerdo?
‫Aquí obtenemos la variable de entorno URL en lugar
‫de la URL real.
‫Ahora, por supuesto, es posible que desee dar
‫la URL real aquí y,
‫para eso, simplemente podría usar otro entorno.
‫Así que aquí puede ver todos los entornos,
‫pero son privados, por lo que en este momento nadie puede
‫usarlos, pero recuerde que
‫en el primer paso, podríamos haber creado
‫esta documentación utilizando uno de los entornos, y probablemente
‫lo haríamos. hemos utilizado el entorno de producción para
‫eso y, por lo tanto, tendríamos la URL de producción
‫final aquí en nuestras URL de API, ¿de acuerdo?
‫De todos modos, así es como
‫se ve la documentación, así que aquí está la solicitud
‫de ejemplo y podemos cambiarla también a nuestro propio idioma.
‫Entonces, en este caso, Node JS,
‫pero si el usuario, por ejemplo, está haciendo
‫una solicitud usando jQuery, entonces puede usar jQuery, está bien.
‫Entonces, solo para ver esta solicitud de ejemplo aquí, con Node, se ve
‫algo como esto.
‫Entonces, aquí tenemos todos nuestros puntos
‫finales y puede ver que los que requieren autenticación,
‫en realidad tienen este ícono de candado aquí.
‫Entonces, en su descripción, ahora podría agregar
‫que dice que necesita iniciar sesión para acceder a este punto
‫final, y también cómo puede iniciar sesión, de acuerdo.
‫O también puede
‫describir eso aquí en la sección de autenticación, ¿verdad?
‫Entonces, idealmente, tendrías descripciones para todo esto.
‫Ah, y aquí veo
‫que en realidad nos olvidamos de reemplazar la contraseña real,
‫pero no importa, ya que esto es solo un ejemplo, ¿de acuerdo?
‫Pero, por supuesto, obtienes todas
‫las solicitudes que teníamos en nuestro cartero también aquí.
‫Ahora, otra característica interesante aquí es que se ejecuta en el botón
‫Postman, por lo que si alguien tiene Postman instalado en
‫su computadora, todo lo que necesita hacer
‫es hacer clic aquí y luego abrir con su aplicación Postman.
‫Ahora no voy a hacer eso en este
‫momento porque, por supuesto, ya lo tengo en mi Postman, pero por
‫lo demás, esta es una característica realmente agradable para que los usuarios sigan
‫adelante y comiencen a experimentar con su API de inmediato.
‫De acuerdo, y creo que eso es todo, así
‫que esto concluye nuestra
‫sección y nuestra API ahora finalmente está realmente completa.
‫Nuevamente, felicitaciones por llegar tan lejos en el
‫curso, ya hemos
‫cubierto mucho terreno aquí juntos.
‫Ahora, a continuación, hay una sección muy, muy emocionante por
‫delante donde finalmente crearemos la cara
‫del usuario para el sitio web de Natours.
‫Entonces, básicamente, usaremos plantillas para
‫crear un sitio web completamente dinámico basado en todos los
‫datos que ya tenemos en nuestra base de datos.
‫Y eso es realmente genial.
‫Y no puedo esperar para mostrártelo.