swagger与spring boot整合

swagger与spring boot整合

前言:
随着现在很多公司的项目都是前后端分离的项目。所以对于前后端开发人员对接口的调试工作又进一步的带来了很多繁琐的工作,所以很多公司都要求配置swagger工具来解决这一难题。废话不多说直接进入正题。
swagger作用:
swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。对接口进行了自动整合生成接口在线文档。也用于后端接口简单测试。
swagger配置:
1.pom.xml


io.springfox
springfox-swagger2
2.9.2


io.springfox
springfox-swagger-ui
2.9.2

在这里插入图片描述

swagger注解:
Controller层注解
类名上:
@api(tags= “controller层的注释”)
在这里插入图片描述

方法名上:

@apiOpration(value = “方法头上的注解,表示方法是干啥用的”)
@ApiImplicitParams({
@apiImplicitParam(name=”接受参数的名称”,value=”描述接受的参数”,request = true(必穿字段,false,不是必穿字段),defultValue=”参数的默认值”)
})
在这里插入图片描述

@apimodel:实体类上的注解
@apimodelProperty(value=“字段的注释”):对象中字段的注解
@apiresponses({
	@apiresponse(code=””,message=’’,response=void.class)

})
在这里插入图片描述

启动类上添加注解
@EnableSwagger2
![在这里插入图片描述](https://img-blog.csdnimg.cn/20200815092849874.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTA1NTk2Mg==,size_16,color_FFFFFF,t_70#pic_center)

这样基本的配置就完成了:可以在浏览器上直接通过路径访问:ip:port/swagger-ui.html (ip你项目的ip;port你项目的端口号)
例如:
localhost:8080/swagger-ui.html
在这里插入图片描述
swagger最基本的用法就说完了,swagger还可以通过配置文件改变swagger-ui.html页面的内容,想听请等下回分解!!!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值