首页 > 其他分享 >三周精通FastAPI:30 API、标签元数据和文档 URL

三周精通FastAPI:30 API、标签元数据和文档 URL

时间:2024-11-04 13:46:13浏览次数:5  
标签:name get URL items app 30 openapi API users

官方文档:https://fastapi.tiangolo.com/zh/tutorial/metadata/

API元数据和文档 URL

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

API 元数据

你可以在设置 OpenAPI 规范和自动 API 文档 UI 中使用的以下字段:

参数类型描述
titlestrAPI 的标题。
summarystrAPI 的简短摘要。 自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。.
descriptionstrAPI 的简短描述。可以使用Markdown。
versionstringAPI 的版本。这是您自己的应用程序的版本,而不是 OpenAPI 的版本。例如 2.5.0 。
terms_of_servicestrAPI 服务条款的 URL。如果提供,则必须是 URL。
contactdict公开的 API 的联系信息。它可以包含多个字段。

contact 字段

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

license_info 字段

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

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

相关文章