Spring Boot整合Swagger2

程序员文章站 2022-07-02 20:57:11

...

手写Api文档的几个痛点：

文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。
接口返回结果不明确
不能直接在线测试接口，通常需要使用工具，比如postman
接口文档太多，不好管理

Swagger也就是为了解决这个问题，当然也不能说Swagger就一定是完美的，当然也有缺点，最明显的就是代码移入性比较强。

一、引入maven依赖

<!-- swagger2 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.8.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.8.0</version>
		</dependency>

二、Swagger配置类

/**
 * Swagger2配置文件
 * 用@Configuration注解该类，等价于XML中配置beans；用@Bean标注方法等价于XML中配置bean。
 * @author z_hh
 * @time 2018年8月1日
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
	/**
	 * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
	 * @return Docket
	 */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // controller的包路径
                .apis(RequestHandlerSelectors.basePackage("cn.zhh.swagger2"))
                .paths(PathSelectors.any())
                .build();
    }
    
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot测试使用Swagger2构建RESTful API")
                //创建人
                .contact(new Contact("Jc丶Zz的博客", "https://blog.csdn.net/qq_31142553", ""))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
 
}

三、在Controller里面使用注解

@RestController
@RequestMapping("/api/open/students")
@Api("学生相关接口")
public class StudentController {

	Map<Integer, Student> students = new HashMap<>();
	
	@PostMapping
	@ApiOperation(value = "新增", notes = "增加一条学生信息")
    @ApiImplicitParam(name = "student", value = "学生对象", dataTypeClass = cn.zhh.swagger2.Student.class, required = true)
	public Map<String, Object> add(@RequestBody Student student) {
		Integer id = student.getId();
		if (Objects.isNull(id)) {
			return new HashMap() {{
				put("success", false);
				put("message", "id不能为空！");
			}};
		}
		
		students.put(id, student);
		return new HashMap() {{
			put("success", true );
			put("content", "新增成功！");
		}};
	}
	
	@GetMapping("/{id}")
	@ApiOperation(value = "根据id查询学生信息", notes = "查询数据库中某个的学生信息")
    @ApiImplicitParam(name = "id", value = "学生ID", paramType = "path", required = true, dataType = "Integer")
	public Map<String, Object> get(@PathVariable Integer id) {
		if (students.containsKey(id)) {
			return new HashMap() {{
				put("success", true);
				put("message", students.get(id));
			}};
		}
		return new HashMap() {{
			put("success", false);
			put("message", "数据不存在！");
		}};
	}
}

对应的学生类

/**
 * 学生实体
 * @author z_hh
 * @time 2018年8月1日
 */
public class Student implements Serializable {
	
	/**
	 * 
	 */
	private static final long serialVersionUID = -6913673650612146588L;

	// id
	private Integer id;
	
	// 姓名
	private String name;
	
	// 性别：1男 2女
	private Integer sex;
	
	// 手机号码
	private String mobile;
	
	// 生日
	private Date birthday;
	
	// 住址
	private String address;
    
    // 省略getter、setter方法