已注销用户的gravatar头像
已注销用户 2017-06-26 16:14:45

swagger和spring MVC集成实例代码分享

写在前面

一直都想弄个小demo,让牛牛们都接触一下swagger,目前来说swagger用的公司还是蛮多的,因为好用所以用的多,

给我最大的感触就是,不用写文档。前后端都可以用的着的一个技术,详细的说了,写看下文!

 

开发工具:eclipse

开发环境:win7 , jdk 1.8

 

主要技术点:swagger , springmvc , spring Boot

 

主要几个文件交代

swagger和spring MVC集成实例代码分享

这里不需要把项目打包,然后添加到tomcat里面,启动方式为 spring boot 只要运行这个类即可。

 

swagger和spring MVC集成实例代码分享端口文件 

我设置的是8081,也就意味着访问时 端口为8081

这个文件可随意修改!

 

项目总体结构

swagger和spring MVC集成实例代码分享

 

运行结构图

swagger和spring MVC集成实例代码分享

 

demo很小,很简单,但是够入门朋友看的了!

也使用了maven!

不会玩maven的请勿下载!  不会玩maven的请勿下载!  不会玩maven的请勿下载!

tips: 使用maven 编译完后 运行Application类,然后访问 http://localhost:8081/swagger/index.html/ (这里的端口如果你修改了也要改为你修改的端口!)

 

附swagger部分注解说明

1. @Api


用在类上,说明该类的作用
@Api(value = "UserController", description = "用户相关api")


2. @ApiOperation

用在方法上,说明方法的作用
@ApiOperation(value = "查找用户", notes = "查找用户", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)


3 @ApiImplicitParams

用在方法上包含一组参数说明


4. @ApiImplicitParam

用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
paramType:参数放在哪个地方
header–>请求参数的获取:@RequestHeader
query–>请求参数的获取:@RequestParam
path(用于restful接口)–>请求参数的获取:@PathVariable
body(不常用)
form(不常用)
name:参数名
dataType:参数类型
required:参数是否必须传
value:参数的意思
defaultValue:参数的默认值

@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "唯一id", required = true, dataType = "Long", paramType = "path"), })

5. @ApiResponses

用于表示一组响应

6. @ApiResponse

用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如”请求参数没填好”
response:抛出异常的类

@ApiResponses(value = {  
          @ApiResponse(code = 400, message = "No Name Provided")  
  })

7. @ApiModel

描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModel(value = "用户实体类")

8. @ApiModelProperty

描述一个model的属性
@ApiModelProperty(value = "登录用户")


打赏

文件名:swagger-springboot.zip,文件大小:946.734K 下载
最代码最近下载分享源代码列表最近下载
hyz419  LV6 2021年9月19日
youwuzuichen  LV10 2020年4月20日
Damionchow  LV4 2019年6月4日
最代码故戌  LV20 2019年4月16日
接口信息  LV1 2018年11月6日
yangctz  LV24 2018年4月25日
土豆也疯狂  LV14 2018年3月30日
yxd1130  LV11 2018年3月12日
可爱的小猪  LV11 2017年12月15日
der2030  LV17 2017年9月29日
最代码最近浏览分享源代码列表最近浏览
空心菜4  LV9 2023年7月16日
孟子大叔  LV7 2022年11月11日
denliv_hui  LV13 2022年2月9日
lironggang  LV37 2021年9月22日
hyz419  LV6 2021年9月18日
秦sir3067683450  LV10 2021年6月2日
开心灬愉悦  LV9 2021年5月2日
zhoujunyu  LV14 2021年4月1日
belly_yao  LV2 2021年2月7日
heqian  LV16 2020年10月13日
顶部 客服 微信二维码 底部
>扫描二维码关注最代码为好友扫描二维码关注最代码为好友