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

 

1、设置文档title:API_TITLE

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

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

 

2、设置版本:API_VERSION

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

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

 

3、配置系统描述:API_DESCRIPTION

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

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

 

4、配置服务条款:API_TERMS_OF_SERVICE

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

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

 

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

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

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

 

6、配置许可证:API_LICENSE_NAME

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

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

 

7、配置许可证地址:API_LICENSE_URL

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

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

 

8、配置BASE_URL:API_HOST

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

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

 

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

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

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

也可单独配置

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

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

 

10、配置协议类型:API_SCHEMES

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

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

 

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

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

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

 

12、配置API Key  - in header

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

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

 

13、配置API Key  - in query

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

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

 

14、配置OAuth2校验

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

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

 

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

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

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

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

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

 

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

 

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

上一篇:[转载]JQuery获取元素文档大小、偏移和位置和滚动条位置的方法集合


下一篇:windows安装rabbitmq安装详细步骤