Documentación automática con Swagger

from fastapi import FastAPI

app = FastAPI()
#Para cambiar el nombre de la aplicacion
app.title = "Mi aplicacion con FastAPI"

#Para cambiar la version de la aplicacion
app.version = "0.0.1"

#los tags nos permite agrupar las rutas de la aplicacion
@app.get("/", tags=['home'])
def read_root():
    return {"Hello": "World"}

Otra manera de definir el titulo y la versión desde la creación de la instancia

app = FastAPI(
    title= 'Aprendiendo FastApi',
    description= 'Una API solo por diversión',
    version= '0.0.1',
)

Si te aparece el JSON así:

Puedes agregar la extensión de google JSON Viewer para que se vea así:

Solo entra en el enlace y selecciona la opción Agregar extensión.

Se puede modificar directamente la información de la App de la siguiente forma:

app = FastAPI(title="nombreAPP",
    description="un intento de api",
    version="0.0.1",
    terms_of_service="http: / / example.com/ terms/",
    contact = {
        "name": "Fidelp27",
        "url": "https://fidelp27.github.io/portfolio/",
        "email": "telocreiste @gmail.com"
    },    
    license_info={
        "name": "Apache 2.0",
        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
   

Y queda de la siguiente forma:

Hermoso código y como se documenta en la web.

Ahora viene lo chido

¿Qué es swagger?
.
Swagger es una especificación abierta para definir las API REST.
.
El documento Swagger especifica la lista de recursos que están disponibles en la API REST y las operaciones que se pueden llamar en esos recursos. El documento también especifica la lista de parámetros de una operación, incluido el nombre y el tipo de los parámetros, si los parámetros son necesarios u opcionales, e información sobre los valores aceptables para dichos parámetros.
.
Además, el documento Swagger puede incluir el esquema JSON que describe la estructura del cuerpo de solicitud que se envía a una operación en una API REST, y el esquema JSON describe la estructura de los cuerpos de respuesta que se devuelven de una operación.

Swagger es una herramienta de código abierto que permite visualizar la documentación de una API de manera interactiva y amigable. FastAPI incluye soporte integrado para Swagger, lo que significa que puedes acceder a la documentación de tu API simplemente navegando a https://localhost:8000/docs. Desde allí, puedes ver información detallada sobre tus endpoints, probarlos directamente desde la interfaz de Swagger, y más. Esta característica es muy útil para desarrolladores y equipos que necesitan trabajar en colaboración en un proyecto de API.

Notas del curso

from fastapi import FastAPI

app = FastAPI()  #creación de una instancia
app.title = "My aplicación con FastAPI"  #Colocar nombre a la app
app.version = "0.0.1" #Colocar version en especifico

#creacion del endpoin
@app.get('/', tags=['home']) #Se agrega el home para agrupar determinadas rutas
def message():
    return "Hello world!"

Para abrir la documentacion se añade a la url /docs

Este profesor explica muy bien