Java swap，Springboot 集成Swagger在线调试

2023-09-26 阅读 29 评论 0

摘要：集成Swagger在线调试转载http://blog.battcn.com/2018/05/16/springboot/v2-config-swagger/ Java swap。SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，

集成Swagger在线调试

转载http://blog.battcn.com/2018/05/16/springboot/v2-config-swagger/

Java swap。SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。

前端和后端唯一联系，变成了API接口；API文档自然就成了前后端开发人员联系的纽带，变得尤为的重要，swagger就是一款让你更好的书写API文档的框架。

文档工具

没有API文档工具之前，基本都是手写API文档的，如有在Word上写的，有在对应的项目目录下readme.md上写的，每个公司都有每个公司的玩法，无所谓好坏。但是这种手写文档带来的弊端就是维护起来苦不堪言，对于接口容易发生变化的开发者来说，维护文档就是噩梦….

好在现如今市场上书写API文档的工具有很多，常见的有postman、yapi、阿里的RAP但是能称之为框架的，估计也只有swagger了。

swagger优缺点

集成方便，功能强大
在线调试与文档生成
代码耦合，需要注解支持，但不影响程序性能

导入依赖

在pom.xml中添加swagger-spring-boot-starter的依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency><groupId>com.battcn</groupId><artifactId>swagger-spring-boot-starter</artifactId><version>1.4.5-RELEASE</version>
</dependency>

属性配置

配置spring.swagger.enabled开启swagger的使用，如果在生产环境中不想用可以在对应的profile下面将它设置为spring.swagger.enabled=false，这样一来接口就不存在暴露的风险

# 扫描的包路径,默认扫描所有
spring.swagger.base-package=com.winterchen
# 默认为 true
spring.swagger.enabled=true

更多属性

实体类

swagger提供了非常齐全的注解，为POJO提供了@ApiModel、@ApiModelProperty，以便更好的渲染最终结果

package com.winterchen.domain;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;import java.io.Serializable;/*** Created by Donghua.Chen on 2018/6/20.*/
@ApiModel
public class User implements Serializable {private static final long serialVersionUID = 8655851615465363473L;private Long id;@ApiModelProperty("用户名")private String username;@ApiModelProperty("密码")private String password;public User() {}public User(Long id, String username, String password) {this.id = id;this.username = username;this.password = password;}// TODO  省略get set
}

restful 风格接口

注解描述

@Api：描述Controller
@ApiIgnore：忽略该Controller，指不对当前类做扫描
@ApiOperation：描述Controller类中的method接口
@ApiParam：单个参数描述，与@ApiImplicitParam不同的是，他是写在参数左侧的。如（@ApiParam(name = "username",value = "用户名") String username）
@ApiModel：描述POJO对象
@ApiProperty：描述POJO对象中的属性值
@ApiImplicitParam：描述单个入参信息
@ApiImplicitParams：描述多个入参信息
@ApiResponse：描述单个出参信息
@ApiResponses：描述多个出参信息
@ApiError：接口错误所返回的信息

package com.winterchen.controller;import com.battcn.swagger.properties.ApiDataType;
import com.battcn.swagger.properties.ApiParamType;
import com.winterchen.domain.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;/*** Created by Donghua.Chen on 2018/6/20.*/
@RestController
@RequestMapping("/users")
@Api(tags = "1.1", description = "用户管理", value = "用户管理")
public class UserController {private static final Logger log = LoggerFactory.getLogger(UserController.class);@GetMapping@ApiOperation(value = "条件查询（DONE）")@ApiImplicitParams({@ApiImplicitParam(name = "username", value = "用户名", dataType = ApiDataType.STRING, paramType = ApiParamType.QUERY),@ApiImplicitParam(name = "password", value = "密码", dataType = ApiDataType.STRING, paramType = ApiParamType.QUERY),})public User query(String username, String password) {log.info("多个参数用  @ApiImplicitParams");return new User(1L, username, password);}@GetMapping("/{id}")@ApiOperation(value = "主键查询（DONE）")@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用户编号", dataType = ApiDataType.LONG, paramType = ApiParamType.PATH),})public User get(@PathVariable Long id) {log.info("单个参数用  @ApiImplicitParam");return new User(id, "u1", "p1");}@DeleteMapping("/{id}")@ApiOperation(value = "删除用户（DONE）")@ApiImplicitParam(name = "id", value = "用户编号", dataType = ApiDataType.LONG, paramType = ApiParamType.PATH)public void delete(@PathVariable Long id) {log.info("单个参数用 ApiImplicitParam");}@PostMapping@ApiOperation(value = "添加用户（DONE）")public User post(@RequestBody User user) {log.info("如果是 POST PUT 这种带 @RequestBody 的可以不用写 @ApiImplicitParam");return user;}@PutMapping("/{id}")@ApiOperation(value = "修改用户（DONE）")public void put(@PathVariable Long id, @RequestBody User user) {log.info("如果你不想写 @ApiImplicitParam 那么 swagger 也会使用默认的参数名作为描述信息 ");}
}

主函数

添加@EnableSwagger2Doc即可

package com.winterchen;import com.battcn.swagger.annotation.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
@EnableSwagger2Doc
public class SpringBootSwaggerApplication {public static void main(String[] args) {SpringApplication.run(SpringBootSwaggerApplication.class, args);}
}