首页 > Windows开发 > 详细

Sanic十八:Sanic 扩展之sanic-openapi生成接口文档之文档配置

时间:2021-08-13 10:05:17      阅读:22      评论:0      收藏:0      [点我收藏+]

 

1、设置文档title:API_TITLE

技术分享图片

技术分享图片

 

2、设置版本:API_VERSION

技术分享图片

技术分享图片

 

3、配置系统描述:API_DESCRIPTION

技术分享图片

技术分享图片

 

4、配置服务条款:API_TERMS_OF_SERVICE

技术分享图片

技术分享图片

 

5、配置邮件联系方式:API_CONTACT_EMAIL

技术分享图片

技术分享图片

 

6、配置许可证:API_LICENSE_NAME

技术分享图片

技术分享图片

 

7、配置许可证地址:API_LICENSE_URL

技术分享图片

技术分享图片

 

8、配置BASE_URL:API_HOST

技术分享图片

技术分享图片

 

9、配置接口统一的前缀:API_BASEPATH

技术分享图片

技术分享图片

也可单独配置

技术分享图片

技术分享图片

 

10、配置协议类型:API_SCHEMES

技术分享图片

技术分享图片

 

11、配置API必须通过身份验证进行访问:API_SECURITY、API_SECURITY_DEFINITIONS

技术分享图片

技术分享图片

 

12、配置API Key  - in header

技术分享图片

技术分享图片

 

13、配置API Key  - in query

技术分享图片

技术分享图片

 

14、配置OAuth2校验

技术分享图片

技术分享图片

 

15、配置是否展示接口末尾"/":API_URI_FILTER,默认不展示,slash展示,All则都展示

技术分享图片

技术分享图片

技术分享图片

技术分享图片

 

更多配置见:https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

 

Sanic十八:Sanic 扩展之sanic-openapi生成接口文档之文档配置

原文:https://www.cnblogs.com/zhongyehai/p/15135140.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!