swagger接口规范说明.doc_第1页
swagger接口规范说明.doc_第2页
swagger接口规范说明.doc_第3页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

1. bean对象中添加注解1.1class上添加注解ApiModel1.2属性上添加注解ApiModelProperty(value = 姓名, example = name)，属性是属于对象关联属性则不需要添加example。事例：2. controller中添加注解2.1class上添加注解Api(description = swagger事例)。Description可以描述这个controller是用来做什么的，ApiIgnore：在class上是过滤掉这个controller不让这个类下面的接口在前端显示，在方法上让这个接口不在前端显示RequestMapping(value = /testObject,method = RequestMethod.POST)Method统一为RequestMethod.POST2.2方法上添加注解2.2.1ApiOperation(value = test,notes = test,produces = application/json)说明：value：方法名notes:方法描述produces：相应格式（统一为application/json）2.2.2ApiImplicitParams( ApiImplicitParam(name = subcategoryId, value = 年级iD, required = true, paramType = query, dataType = string) )说明：参数传入每一个ApiImplicitParam表示一个参数name:参数名，通过request.getParameter(name).的名字value:说明required：是否必填，true:必填，false：不必填paramType：参数获取类型（统一使用query）dataType：数据类型事例：如果没有返回数据对象，只需返回ResultObjec
人人文库> 全部分类> 行业资料 > 管理策划

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论