前面的Fastapi
用户指南已经可以满足开发简单的接口了,但是开发的接口只有自己知道,为了项目组的前端和测试都能知道,Fastapi
框架引入了Swagger UI
来进行展示。
from fastapi import FastAPI
app = FastAPI(
title="Fastapi接口文档",
version="0.0.1",
description="接口文档",
terms_of_service="https://www.baidu.com",
docs_url=None,
redoc_url=None,
contact={
"name": "访问百度",
"url": "http://www.baidu.com/",
"email": "debug@163.com",
}
)
参数注释 :
title
:名称(浏览器标签页的title)version
:版本号description
:描述信息terms_of_service
:配置一个外链跳转,界面显示是terms_of_service
docs_url
:docs文档界面redoc_u