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/