Sanic十八:Sanic 扩展之sanic-openapi生成接口文档之文档配置
2021/8/12 23:08:54
本文主要是介绍Sanic十八:Sanic 扩展之sanic-openapi生成接口文档之文档配置,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
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生成接口文档之文档配置的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-12-29uni-app 中使用 Vant Weapp,怎么安装和配置npm ?-icode9专业技术文章分享
- 2024-12-27Nacos多环境配置学习入门
- 2024-12-27Nacos快速入门学习入门
- 2024-12-27Nacos快速入门学习入门
- 2024-12-27Nacos配置中心学习入门指南
- 2024-12-27Nacos配置中心学习入门
- 2024-12-27Nacos做项目隔离学习入门
- 2024-12-27Nacos做项目隔离学习入门
- 2024-12-27Nacos初识学习入门:轻松掌握服务发现与配置管理
- 2024-12-27Nacos初识学习入门:轻松掌握Nacos基础操作