SpringBoot集成Swagger2生成接口文档

原文地址： https://itweknow.cn/detail?id=56 ，欢迎大家访问。

我们提供Restful接口的时候，API文档是尤为的重要，它承载着对接口的定义，描述等。它还是和API消费方沟通的重要工具。在实际情况中由于接口和文档存放的位置不同，我们很难及时的去维护文档。个人在实际的工作中就遇到过很多接口更新了很久，但是文档却还是老版本的情况，其实在这个时候这份文档就已经失去了它存在的意义。而Swagger是目前我见过的最好的API文档生成工具，使用起来也很方便，还可以直接调试我们的API。我们今天就来看下Swagger2与SpringBoot的结合。

准备工作

• 一个SpringBoot项目，可以直接去官网生成一个demo。
• 一个用户类。

package cn.itweknow.springbootswagger.model;

import java.io.Serializable;

/**
 * @author ganchaoyang
 * @date 2018/12/19 10:29
 * @description
 */
public class User implements Serializable {
   

    private Integer id;

    private String name;

    private String password;

    private String email;
}

项目依赖

Web Service肯定是一个Web项目，所以我们这里依赖了spring-boot-starter-web包，其他两个包就是和Swagger相关的包了。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId