3.5. FastAPI Documentation — Python
Generate Documentation
What is OpenAPI?
Swagger vs. Redoc
3.5.1. Example
>>> from fastapi import FastAPI >>> app = FastAPI() >>> >>> >>> @app.get('/user/active') ... def active(): ... return {'data': 'list all active users'} >>> >>> >>> @app.get('/user/{id}') ... def show_by_id(id: int): ... return {'data': id} >>> >>> >>> @app.get('/user/{firstname}-{lastname}') ... def show_by_name(firstname: str, lastname: str): ... return {'data': f'{firstname} {lastname}'} >>> >>> >>> @app.get('/user/{id}/friends') ... def show_friends(id: int): ... return {'data': 'comments'}
$ uvicorn main:app --reload INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) INFO: Started reloader process [68005] using watchgod INFO: Started server process [68007] INFO: Waiting for application startup. INFO: Application startup complete.
Open browser to:
Swagger: http://127.0.0.1:8000/docs
ReDoc: http://127.0.0.1:8000/recdoc