标签：produces doc Sanic 接口 openapi sanic

 

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

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。