文件名称:
springboot 集成Swagger2
开发工具:
文件大小: 294kb
下载次数: 0
上传时间: 2019-03-04
详细说明:使用springmvc时通过sprngboot配置swagger2。
RESTful 架构,是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得
到越来越多网站的采用。后端通过提供一套标准的RESTful API,让网站,移动端和第通过 Swagger-U,浏览器输入:htp:/ localhost.8080/ sWagger- ui.html
e c o(O localhost: 8080/swagger-uihtn
图百度 co]e GitH
MACIE
f swagger
tefdull('v2api-dces!,
Explore
spring Boot工程中使用 swagger构建 restful apis
情青关注事容;hp/www.ydczlly
三、生成 Swagger2文档的注解
Swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。
Api:修饰整个类,描述 Controller的作用
ApiOperation:描述一个类的一个方法,或者说一个接口
ApiParan:单个参数描述
ApiModel:用对象来接收参数
· ApiModelProperty:用对象接收参数时,描述对象的一个字段
ApiResponse:HTTP响应其中1个描述
ApiResponses:HTTP响应整体描述
Apilgnore:使用该注解忽略这个AP
ApilmplicitParam:一个请求参数
Apilmplicit Params多个请求参数
四、示例
package com. baiZhi control ler
import com. baizhi entity. User
Import 10. swagger.annotations. "
import org. springframework. web. bind annotation. * i
author gaozhy
adate2018/9/25.16:51
GApi( value=" swagger controller",tags=" swagger操作接口")
GRestController
RequestMapping("/swagger")
public class He l loswaggercontroller t
Aploperatl on( value="根据用户名获取欢迎语", notes="注意事项")
GetMapping( /sayHello")
public string sayHello(aApi Param(name="name", value="BFg", required= true)
Requestparamcrequired- true)
String name)t
return Hello:"tname
//ApiIgnore
Aploperatlon( value="新增用户信息")
apostMapping /add")
pub1 ic String addUser( RequestBody ApI Param(name="user", value="用户对象", required=
true) User user)t
System. out. printIn (user)
returnOK
Aploperatlon( value="根据年龄和姓名查询用户信息")
ApiImplicitParams([
ApiImp1 1CtParam(name=" useaGe", value="用户年龄", required=
true, dataTypeclass Integer class, paramType =query")
ApiImplicitParam(name="name", value="用户姓名", dataType=" string", paratYpe
query
GetMapping ("/select")
Api Responses (i
Api Response(code=404, message="没有找到资源"),
Apl Response(code=401, message="权限不够")
public String selectUser (aRequestParam("userAge")Integer age, String name)t
return age +I+name
(系统自动生成,下载前可以参看下载内容)
下载文件列表
相关说明
- 本站资源为会员上传分享交流与学习,如有侵犯您的权益,请联系我们删除.
- 本站是交换下载平台,提供交流渠道,下载内容来自于网络,除下载问题外,其它问题请自行百度。
- 本站已设置防盗链,请勿用迅雷、QQ旋风等多线程下载软件下载资源,下载后用WinRAR最新版进行解压.
- 如果您发现内容无法下载,请稍后再次尝试;或者到消费记录里找到下载记录反馈给我们.
- 下载后发现下载的内容跟说明不相乎,请到消费记录里找到下载记录反馈给我们,经确认后退回积分.
- 如下载前有疑问,可以通过点击"提供者"的名字,查看对方的联系方式,联系对方咨询.