官方文档:https://fastapi.tiangolo.com/zh/tutorial/metadata/
API元数据和文档 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 的联系信息。它可以包含多个字段。
|
license_info | dict | 公开的 API 的许可证信息。它可以包含多个字段。
|
你可以按如下方式设置它们:
from fastapi import FastAPI
description = """
ChimichangApp API helps you do awesome stuff.
标签:name,get,URL,items,app,30,openapi,API,users
From: https://blog.csdn.net/skywalk8163/article/details/143467339