fastapi_minimal_openapi_spec_auto_generation_quickstart.py

1from fastapi import FastAPI
2
3# Create an instance of the FastAPI class
4app = FastAPI()
5
6# Define a path operation decorator for the root path
7@app.get("/")
8async def root():
9    """
10    This docstring will be used as the description for this 
11    endpoint in the generated OpenAPI documentation.
12    """
13    return {"message": "Hello World"}
14
15# To view the generated OpenAPI spec:
16# 1. Run the app: uvicorn main:app --reload
17# 2. Go to: http://127.0.0.1:8000/openapi.json