mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-25 07:08:11 -05:00
a071ddf3cd
* Allow to add OpenAPI tag descriptions * fix type hint * fix type hint 2 * refactor test to assure 100% coverage * 📝 Update tags metadata example * 📝 Update docs for tags metadata * ✅ Move tags metadata test to tutorial subdir * 🎨 Update format in applications * 🍱 Update docs UI image based on new example * 🎨 Apply formatting after solving conflicts Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
29 lines
693 B
Python
29 lines
693 B
Python
from fastapi import FastAPI
|
|
|
|
tags_metadata = [
|
|
{
|
|
"name": "users",
|
|
"description": "Operations with users. The **login** logic is also here.",
|
|
},
|
|
{
|
|
"name": "items",
|
|
"description": "Manage items. So _fancy_ they have their own docs.",
|
|
"externalDocs": {
|
|
"description": "Items external docs",
|
|
"url": "https://fastapi.tiangolo.com/",
|
|
},
|
|
},
|
|
]
|
|
|
|
app = FastAPI(openapi_tags=tags_metadata)
|
|
|
|
|
|
@app.get("/users/", tags=["users"])
|
|
async def get_users():
|
|
return [{"name": "Harry"}, {"name": "Ron"}]
|
|
|
|
|
|
@app.get("/items/", tags=["items"])
|
|
async def get_items():
|
|
return [{"name": "wand"}, {"name": "flying broom"}]
|