python:Fastapi - 元数据和文档 URL

前面的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
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值