Описание APIRouter в FastAPI?

Предположим, у меня есть следующий пример кода:

from fastapi import APIRouter, FastAPI

router_one = APIRouter(tags=["users"])
router_two = APIRouter(tags=["products"])

app = FastAPI(description = "## Description for whole application")

@router_one.get("/users")
async def fn1():
    pass

@router_one.post("/users")
async def fn2():
    pass

@router_two.get("/products")
async def fn3():
    pass

@router_two.post("/products")
async def fn4():
    pass

app.include_router(router_one)
app.include_router(router_two)

Он отображается, как показано ниже, в чванстве:

Я знаю, что могу передать аргумент description для отдельных функций операций с путем, но что мне действительно нужно, так это передать аргумент description самому APIRouter (я показал на рисунке). У меня есть некоторая общая информация, которая используется всеми операциями пути под определенным тегом, например users.

Я заметил, что в FastAPI для этого нет такого API:

router_one = APIRouter(tags=["users"], description=...)

# or

app.include_router(router_one, description=...)

Есть ли другой способ добиться этого?

Почему в Python есть оператор "pass"?
Почему в Python есть оператор "pass"?
Оператор pass в Python - это простая концепция, которую могут быстро освоить даже новички без опыта программирования.
Некоторые методы, о которых вы не знали, что они существуют в Python
Некоторые методы, о которых вы не знали, что они существуют в Python
Python - самый известный и самый простой в изучении язык в наши дни. Имея широкий спектр применения в области машинного обучения, Data Science,...
Основы Python Часть I
Основы Python Часть I
Вы когда-нибудь задумывались, почему в программах на Python вы видите приведенный ниже код?
LeetCode - 1579. Удаление максимального числа ребер для сохранения полной проходимости графа
LeetCode - 1579. Удаление максимального числа ребер для сохранения полной проходимости графа
Алиса и Боб имеют неориентированный граф из n узлов и трех типов ребер:
Оптимизация кода с помощью тернарного оператора Python
Оптимизация кода с помощью тернарного оператора Python
И последнее, что мы хотели бы показать вам, прежде чем двигаться дальше, это
Советы по эффективной веб-разработке с помощью Python
Советы по эффективной веб-разработке с помощью Python
Как веб-разработчик, Python может стать мощным инструментом для создания эффективных и масштабируемых веб-приложений.
2
0
50
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вы можете использовать параметр openapi_tags класса FastAPI, как показано ниже:

from fastapi import APIRouter, FastAPI

router_one = APIRouter(tags=["users"])
router_two = APIRouter(tags=["products"])

app = FastAPI(
    description = "## Description for whole application",
    openapi_tags=[
        {"name": "users", "description": "Operations with users"},
        {
            "name": "products",
            "description": "Operations with products",
            "externalDocs": {
                "description": "Items external docs",
                "url": "https://fastapi.tiangolo.com/",
            },
        },
    ],
)


@router_one.get("/users")
async def fn1():
    pass


@router_one.post("/users")
async def fn2():
    pass


@router_two.get("/products")
async def fn3():
    pass


@router_two.post("/products")
async def fn4():
    pass


app.include_router(router_one)
app.include_router(router_two)

Результат

Другие вопросы по теме