springboot 整合swagger

现在项目中都是使用前端后台分离的开发方式,而使两者紧密联系着的就是API文档了,swagger就是一个很好的生成API文档的工具。

首先在项目中导入swagger相关的依赖

使用@Configuration注解,创建一个swagger配置类,并使用@EnableSwagger2注解开启swagger

生成Docket和ApiInfo这两个对象

在controller类上使用注解:

@Api(value = "/", description = "")

在controller类中的方法上使用注解

@ApiOperation(value = "查询公司集合 ", produces = "application/json")
@RequestMapping(value = "/getCompanyList", method = { RequestMethod.POST, RequestMethod.GET })
@ApiImplicitParams({
      @ApiImplicitParam(paramType = "query", name = "sequence", dataType = "String", required = true, 
value = "流水号,必填")})
      

最后访问生成的api文档:

http://localhost:8080/swagger-ui.html进行访问调试

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值