将 FastApi 文档分成几个部分

Question

目前 OpenAPI 文档如下所示： 是否可以将其分成多个部分？

例如，2 个部分，一个是“books”部分，包含来自“/api/bookcollection/books/”端点的方法，另一个包含“/api/bookcollection/authors/”端点的方法。

我查阅了 FastApi文档，但没有找到任何接近我想要执行的操作的内容。

Answer 1

允许OpenAPI 使用标签对端点进行分组。FastAPI也支持这个功能。文档部分可以在这里找到。

例子：

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"}]