元数据和文档URL¶

你可以在你的 FastAPI 应用程序中自定义多个元数据配置。

API 元数据¶

你可以设置以下用于 OpenAPI 规范和自动 API 文档 UI 的字段：

参数类型描述

title str API 的标题。

summary str API 的简短摘要。自 OpenAPI 3.1.0 和 FastAPI 0.99.0 起可用。

description str API 的简短描述。可以使用 Markdown。

version string API 的版本。这是你自己的应用程序的版本，而不是 OpenAPI 的版本。例如 2.5.0。

terms_of_service str API 的服务条款的 URL。如果提供，这必须是一个 URL。

contact

dict

公开 API 的联系信息。它可以包含多个字段。

contact 字段

参数	类型	描述
`name`	`str`	联系人/组织的标识名称。
`url`	`str`	指向联系信息的 URL。必须为 URL 格式。
`email`	`str`	联系人/组织的电子邮件地址。必须为电子邮件地址格式。

license_info

dict

公开 API 的许可证信息。它可以包含多个字段。

license_info 字段

参数	类型	描述
`name`	`str`	REQUIRED（如果设置了 `license_info`）。用于 API 的许可证名称。
`identifier`	`str`	API 的 SPDX 许可证表达式。`identifier` 字段与 `url` 字段互斥。自 OpenAPI 3.1.0 和 FastAPI 0.99.0 起可用。
`url`	`str`	指向用于 API 的许可证的 URL。必须为 URL 格式。

你可以按如下方式设置它们：

from fastapi import FastAPI

description = """
ChimichangApp API helps you do awesome stuff. 🚀

## Items

You can **read items**.

## Users

You will be able to:

* **Create users** (_not implemented_).
* **Read users** (_not implemented_).
"""

app = FastAPI(
    title="ChimichangApp",
    description=description,
    summary="Deadpool's favorite app. Nuff said.",
    version="0.0.1",
    terms_of_service="http://example.com/terms/",
    contact={
        "name": "Deadpoolio the Amazing",
        "url": "http://x-force.example.com/contact/",
        "email": "dp@x-force.example.com",
    },
    license_info={
        "name": "Apache 2.0",
        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    },
)


@app.get("/items/")
async def read_items():
    return [{"name": "Katana"}]

Tip

你可以在 description 字段中编写 Markdown，它将在输出中渲染。

通过此配置，自动 API 文档将如下所示：

许可证标识符¶

自 OpenAPI 3.1.0 和 FastAPI 0.99.0 起，你还可以使用 identifier 而不是 url 来设置 license_info。

例如：

from fastapi import FastAPI

description = """
ChimichangApp API helps you do awesome stuff. 🚀

## Items

You can **read items**.

## Users

You will be able to:

* **Create users** (_not implemented_).
* **Read users** (_not implemented_).
"""

app = FastAPI(
    title="ChimichangApp",
    description=description,
    summary="Deadpool's favorite app. Nuff said.",
    version="0.0.1",
    terms_of_service="http://example.com/terms/",
    contact={
        "name": "Deadpoolio the Amazing",
        "url": "http://x-force.example.com/contact/",
        "email": "dp@x-force.example.com",
    },
    license_info={
        "name": "Apache 2.0",
        "identifier": "MIT",
    },
)


@app.get("/items/")
async def read_items():
    return [{"name": "Katana"}]

标签元数据¶

你还可以为用于分组路径操作的各个标签添加额外的元数据，使用参数 openapi_tags。

它接受一个包含每个标签一个字典的列表。

每个字典可以包含：

name（必需）：一个 str，与你在路径操作和 APIRouter 中使用的 tags 参数中的标签名称相同。
description：一个 str，为标签提供简短描述。它可以包含 Markdown，并将在文档 UI 中显示。
externalDocs：一个 dict，描述外部文档，包含：
- description：一个 str，为外部文档提供简短描述。
- url（必需）：一个 str，包含外部文档的 URL。

创建标签元数据¶

让我们在一个示例中尝试使用 users 和 items 标签。

为你的标签创建元数据，并将其传递给 openapi_tags 参数：

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

注意，你可以在描述中使用 Markdown，例如 "login" 将以粗体（login）显示，"fancy" 将以斜体（fancy）显示。

Tip

你不必为所有使用的标签添加元数据。

使用你的标签¶

使用 tags 参数与你的路径操作（和 APIRouter）来将它们分配给不同的标签：

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

Info

更多关于标签的信息，请参阅路径操作配置。

查看文档¶

现在，如果你查看文档，它们将显示所有额外的元数据：

标签顺序¶

每个标签元数据字典的顺序也定义了在文档 UI 中显示的顺序。

例如，尽管 users 在字母顺序上会排在 items 之后，但由于我们将其元数据作为列表中的第一个字典添加，因此它显示在它们之前。

OpenAPI URL¶

默认情况下，OpenAPI 模式在 /openapi.json 提供。

但你可以通过参数 openapi_url 进行配置。

例如，将其设置为在 /api/v1/openapi.json 提供：

from fastapi import FastAPI

app = FastAPI(openapi_url="/api/v1/openapi.json")


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

如果你想完全禁用 OpenAPI 模式，可以设置 openapi_url=None，这也会禁用使用它的文档用户界面。

文档 URL¶

你可以配置包含的两个文档用户界面：

Swagger UI：在 /docs 提供。
- 你可以通过参数 docs_url 设置其 URL。
- 你可以通过设置 docs_url=None 来禁用它。
ReDoc：在 /redoc 提供。
- 你可以通过参数 redoc_url 设置其 URL。
- 你可以通过设置 redoc_url=None 来禁用它。

例如，将 Swagger UI 设置为在 /documentation 提供并禁用 ReDoc：

from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]