No tienes acceso a esta clase

¡Continúa aprendiendo! Únete y comienza a potenciar tu carrera

Documentación interactiva de una API

6/20
Recursos

Aportes 23

Preguntas 3

Ordenar por:

Los aportes, preguntas y respuestas son vitales para aprender en comunidad. Regístrate o inicia sesión para participar.

FastAPI también está parado sobre los hombros de OpenAPI, el cual es un conjunto de reglas que permite definir cómo describir, crear y visualizar APIs. Es un conjunto de reglas que permiten decir que una API está bien definida.

OpenAPI necesita de un software, el cual es Swagger, que es un conjunto de softwares que permiten trabajar con APIs. FastAPI funciona sobre un programa de Swagger el cual es Swagger UI, que permite mostrar la API documentada.

Acceder a la documentación interactiva con Swagger UI:
{localhost}/docs

Acceder a la documentación interactiva con Redoc:
{localhost}/redoc

Apuntes de la clase :
Click Aqui

Si quieren visualizar mejor los archivos JSON instalen el complemento de Chrome (en Firefox también hay uno) llamado
JSON Formatter y se les vará algo así:

Saludos!

OPEN API: es una especificación que define como describir, crear y visualzar API’s. Permite reconocer si una API está definida adecuadamente. Require de Swagger.
Swagger: software para trabajar API’s.
ReDoc es una alternativa de Swagger instalada por default con FastAPI.

FastAPI funciona sobre SwaggerUI (User Interface) que permite mostrar graficamente la API documentada. SwaggerUI obtiene especificaciones de OPEN API y la muestra por Fast API.

OPEN API - Swagger - FastAPI

localhost/docs -> Swagger UI
OAS3 (Open API Specification).


localhost/redoc-> ReDoc

Pueden descargar el open.json y depues importarlo en sus Postman para hacer el testeo de su API , ademas pueden convertir el archivo JSON que da el swagger a formato yaml aqui el link
https://editor.swagger.io/
para crear los endpoints para google cloud, saludos

OpenAPI

Les recomiendo bajar dentro de las extenciones de Chrome JSON Viewer, esto les permite que el código json que se muestra salgo mucho mas bonito y legible

OMG esto va ser épico papus!!! .jpg

Para utilizar Swagger con Spring, o en NodeJs, se debe realizar una importación. En el caso de un proyecto con Java y Spring, se deben utilizar decoradores y documentar cada endPoint

We can see two software tools than we have to documentation:

  • swagger
  • redoc

We can access to swagger with follow link 127.0.0.1:8000/docs or
redoc with follow link 127.0.0.1:80000/redoc

Documentación interactiva de una API

FastAPI funciona sobre, también, OpeanAPI. Es un conjunto de reglas que permite definir algo, en este caso, como describir APIs.

Pero necesitamos usar Swagger o ReDoc.

Si ingresas a ‘https://localhost:8000/docs’ verás que ya tienes la documentación creada con Swagger.

Si ingresas a ‘https://localhost:8000/redoc’ verás que ya tienes la documentación creada con ReDoc.

Genial Swagger y ReDoc hace que compartir nuestras API’s sea mucho más sencillo. Personalmente me gustó más la visualización de ReDoc. Por otra parte, es chévere ver como Facundo logra transmitir el mismo entusiasmo que se lee en la documentación de FastAPI. Es genial saber que un latino es el creador de este gran Framework.

Increíble! De verdad al iniciar me preocupaba como hacer que los demás puedan consumir la API y con Swagger lo hace mucho más fácil

Si bien no esta ni cerca de ser lo pedoroso que es Postman, como su nombre lo dice ‘FastApi’, para pruebas rapidas de que todo va marchando bien, creo que esta super bien!

Que ganas de seguir aprendiendo. Vamos por más.

Siempre que los profesores abren sus carpetas o algo por el estilo no puedo evitar chusmear.
Digo esto porque usa el mismo ecualizador que yo! jajaj

wooooo esto esta brutal

Si usas el navegador Firefox developer edition, por defecto te muestra todos los JSON en formato mas legible

Que cool que utiliza swagger

Swagger es un amor al igual que reddoc no me imagino el dolor de cabeza del creador para regalarnos esto

La verdad. Me quedo con:

http://127.0.0.1:8000/docs

Que genera una documentación en base al código es un ahorro de tiempo muy grande sobre todo para pruebas o desarrollos rápidos donde queremos testear una idea y participan otras personas desarrollando.

Documentación interactiva de una API

FastAPI también está parado sobre los hombros de OpenAPI, el cual es un conjunto de reglas que permite definir cómo describir, crear y visualizar APIs. Es un conjunto de reglas que permiten decir que una API está bien definida.

OpenAPI necesita de un software, el cual es Swagger, que es un conjunto de softwares que permiten trabajar con APIs. FastAPI funciona sobre un programa de Swagger el cual es Swagger UI, que permite mostrar la API documentada.

Acceder a la documentación interactiva con Swagger UI:

{localhost}/docs
Acceder a la documentación interactiva con Redoc:

{localhost}/redoc