码迷,mamicode.com
首页 > 其他好文 > 详细

Swagger字段说明

时间:2018-05-18 14:11:11      阅读:970      评论:0      收藏:0      [点我收藏+]

标签:code   ati   ali   produces   summary   详细   默认   als   OLE   

常用字段说明

字段 说明
schemes 使用协议(如:httphttps
host 项目地址,这个地址会作为每个接口的url base,拼接起来一起作为防伪地址
consumes 接口默认接收的MIME类型(如:formData
produces 接口默认返回MIME类型。api接口用的比较多的是 application/jsonapplication/xml
summary 接口的简要介绍,会显示在接口标头上,不能超过120个字符
description 接口的详细介绍
externalDocs 外部文档连接
operationId 全局唯一的接口标识
parameters 参数列表
@SWG\Info 此项填写的内容会放在文档开头,用作文档说明
@SWG\TAG tag是用来给文档分类的,name字段必须唯一,某个接口可以指定多个tag,那它就会出现在多组分类中(tag也可以不用在这里预先定义)
@SWG\Get 通过get的方式请求数据
@SWG\Post 通过post的方式请求数据

@SWG\Parameter常用字段说明

字段 说明
name 参数名
in 参数的来源,必填,取值范围:queryheaderpathformDatabody
description 参数描述
type 参数类型,取值范围:stringnumberintegerbooleanarrayfile
required 参数是否必须,取值范围:truefalse (通过路径传参in="path"时必须为true)
default 参数的默认值

传送门

swagger官方文档
swagger从入门到精通

Swagger字段说明

标签:code   ati   ali   produces   summary   详细   默认   als   OLE   

原文地址:https://www.cnblogs.com/littleBit/p/9055450.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!