其他分享
首页 > 其他分享> > Sanic十九:Sanic 扩展之sanic-openapi生成接口文档之doc提供的一些装饰器

Sanic十九:Sanic 扩展之sanic-openapi生成接口文档之doc提供的一些装饰器

作者:互联网

 

sanic-openapi除了可以使用app.config来指定一些基础的配置外,sanic-openapi.doc还提供了很多装饰器用法的配置,导入doc模块

 

1、exclude(True):用此装饰器修饰的路由将不会显示在Swagger中

 

2、summary():添加接口的概述

 

3、description():接口描述

 

4、tag():接口分组,默认情况下,接口会根据蓝图名分组,当没有指定时,会用default

 

5、operation():Sanic默认会用路由修饰的函数名作为路由的终结点,可以用operation来指定终结点名称

 

6、consumes():指定参数类型和参数示例

查询字符串参数

header参数

body参数

 

7、produces():200状态的响应示例

 

8、response():其他响应,当同时使用了response和produces时,200的响应使用produces设置的值

 

标签:produces,doc,Sanic,接口,openapi,sanic
来源: https://www.cnblogs.com/zhongyehai/p/15141548.html