FastAPI 学习之路(三十七)元数据和文档 URL
2023-09-27 14:27:40 时间
你可以在 FastAPI 应用中自定义几个元数据配置。
你可以设定:
-
Title:在 OpenAPI 和自动 API 文档用户界面中作为 API 的标题/名称使用。
-
Description:在 OpenAPI 和自动 API 文档用户界面中用作 API 的描述。
-
Version:API 版本,例如
v2
或者2.5.0
。 -
如果你之前的应用程序版本也使用 OpenAPI 会很有用。
我们看下如何使用的
description = """ 用户创建和items创建 ## Items 你可以读他们 ## Users 你可以做下面的: * **创建用户** * **读取用户** . """ app = FastAPI( title="系统接口", description=description, version="0.0.1" )
我们看下实现后的效果,
你也可以使用参数 openapi_tags
,为用于分组路径操作的不同标签添加额外的元数据。
它接受一个列表,这个列表包含每个标签对应的一个字典。
每个字典可以包含:
-
name
(必要):一个str
,它与路径操作和APIRouter
中使用的tags
参数有相同的标签名。 -
description
:一个用于简短描述标签的str
。它支持 Markdown 并且会在文档用户界面中显示。 -
externalDocs
:一个描述外部文档的dict
: -
description
:用于简短描述外部文档的str
。 -
url
(必要):外部文档的 URLstr
。
使用方式
from fastapi import FastAPI from routers.user import usersRouter from routers.items import itemsRouter tags_metadata = [ { "name": "系统接口", "description": """ 用户创建和items创建 """}, { "name": "items", "description": "管理items,你可以查看文档", "externalDocs": { "description": "使用文档", "url": "http://localhost:8000/docs#/Itmes", }, }, ] app = FastAPI( openapi_tags=tags_metadata ) app.include_router(usersRouter, prefix="/user", tags=['users']) app.include_router(itemsRouter, prefix="/items", tags=['Itmes'])
最后的效果
文档 URLs
你可以配置两个文档用户界面,包括:
-
Swagger UI:服务于
/docs
。 -
可以使用参数
docs_url
设置它的 URL。 -
可以通过设置
docs_url=None
禁用它。 -
ReDoc:服务于
/redoc
。 -
可以使用参数
redoc_url
设置它的 URL。 -
可以通过设置
redoc_url=None
禁用它。
我们一直没有看过redoc,我们今天看下
我们重新定义下对应的文档的地址
app = FastAPI( openapi_tags=tags_metadata, docs_url="/openapi", redoc_url="/apidoc" )
我们启动后看下。
必须要访问新的地址
当然我们也可以禁用,可以根据我们的需求来。
文章首发在公众号,欢迎关注。
相关文章
- Mongoose学习参考文档——基础篇
- (《机器学习》完整版系列)第11章 特征选择与稀疏学习——11.5 稀疏表示与字典学习(字典、词频、文档的特征)
- 《Log4j 2 官方文档》Testing in Maven
- 《Spark 官方文档》在YARN上运行Spark
- 【QT】Qt 5 的程序:打印文档
- AppleWatch开发教程之调试程序使用帮助文档
- python学习之word文档转换成pdf文档
- CHM文档打开空白的解决
- XML文档形式&JAVA抽象类和接口的区别&拦截器过滤器区别
- overlay(_:alignment:) (SwiftUI中文文档手册)
- Android File类 根据官方文档理解(转)
- 云数据恢复:文档是成功的关键
- 严重: 文档无效: 找不到语法。 at (null:2:19)
- (二十二)unity4.6学习Ugui中文文档-------交互-Eventsystem & Binding
- Golang 1.0 文档使用。godoc ,go 命令 学习 ,本地运行 gotour
- 轮播swiper组件官方文档