元数据和文档 URL¶

你可以在 FastAPI 应用中自定义多项元数据配置。

API 元数据¶

你可以设置以下字段，这些字段将用于 OpenAPI 规范和自动生成的 API 文档界面：

参数类型描述

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`	必需（如果设置了 `license_info`）。API 使用的许可证名称。
`identifier`	`str`	API 的 SPDX 许可证表达式。`identifier` 字段与 `url` 字段互斥。OpenAPI 3.1.0 和 FastAPI 0.99.0 起可用。
`url`	`str`	指向 API 所用许可证的 URL。必须是 URL 格式。

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

Python 3.10+

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://apache.ac.cn/licenses/LICENSE-2.0.html",
    },
)


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

提示

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

使用此配置，自动生成的 API 文档将如下所示

许可证标识符¶

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

例如

Python 3.10+

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": "Apache-2.0",
    },
)


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

标签元数据¶

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

它接收一个包含字典的列表，每个标签对应一个字典。

每个字典可以包含：

name (必需)：与你在路径操作和 APIRouter 中 tags 参数使用的名称相同的 str。
description：该标签的简短描述 str。可以使用 Markdown，并将显示在文档界面中。
externalDocs：一个描述外部文档的 dict，包含：
- description：外部文档的简短描述 str。
- url (必需)：指向外部文档的 URL str。

创建标签元数据¶

让我们通过一个包含 users 和 items 标签的例子来演示。

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

Python 3.10+

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.org.cn/",
        },
    },
]

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)。

提示

你无需为你使用的所有标签都添加元数据。

使用标签¶

在路径操作（和 APIRouter）中使用 tags 参数，将它们分配给不同的标签

Python 3.10+

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.org.cn/",
        },
    },
]

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

信息

在路径操作配置中阅读更多关于标签的内容。

检查文档¶

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

标签顺序¶

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

例如，即使 users 按字母顺序排列在 items 之后，它也会显示在它们前面，因为我们将它们的元数据作为列表中的第一个字典添加了。

OpenAPI URL¶

默认情况下，OpenAPI 模式服务于 /openapi.json。

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

例如，将其设置为服务于 /api/v1/openapi.json：

Python 3.10+

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：

Python 3.10+

from fastapi import FastAPI

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


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