SpringBoot 2.x中使用Swagger 2生成api文档

启动项目后，输入 http://localhost:8080/swagger-ui.html，显示的api文档页面如下：

来讲讲是怎么实现的 

首先创建一个springboot工程，我的是通过Spring Assistant创建的，有的是用Spring Initializer，都需要联网才能创建

我的项目结构如下：

pom.xml文件引入依赖：

		
		
			org.springframework.boot
			spring-boot-starter-web
		
		
		
			io.springfox
			springfox-swagger2
			2.7.0
		
		
		
			io.springfox
			springfox-swagger-ui
			2.7.0
		

其中SwaggerConfiguration内容如下：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
//可以不用添加controller类所在的包名，swagger会自动识别
//                .apis(RequestHandlerSelectors.basePackage("com.zl.controller"))  
                .paths(PathSelectors.any())
                .build();
    }


//生成文档页面上的显示信息，可自定义
    private ApiInfo apiInfo() {
        Contact contact = new Contact("zl", "https://blog.csdn.net/a13545564067", "");
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring Boot相关文章请关注：https://blog.csdn.net/a13545564067")
                .termsOfServiceUrl("https://blog.csdn.net/a13545564067")
                .contact(contact)
                .version("1.0")
                .build();
    }

}

实体类User内容如下：

public class User {

    private Long id;
    private String name;
    private Integer age;

    // setter和getter

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public Integer getAge() {
        return age;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

控制类UserController内容如下：

import com.zl.entity.User;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;

import java.util.*;


@RestController
@RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下，可去除
public class UserController {

    static Map users = Collections.synchronizedMap(new HashMap());

    @ApiOperation(value="获取用户列表", notes="")   //描述api
    @RequestMapping(value={""}, method=RequestMethod.GET)
    public List getUserList() {
        List r = new ArrayList(users.values());
        return r;
    }

    @ApiOperation(value="创建用户", notes="根据User对象创建用户")
    @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    @RequestMapping(value="", method=RequestMethod.POST)
    public String postUser(@RequestBody User user) {
        users.put(user.getId(), user);
        return "success";
    }

    @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }

    @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }

    @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }

}

启动类SwaggerTestApplication内容如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SwaggerTestApplication {

	public static void main(String[] args) {
		SpringApplication.run(SwaggerTestApplication.class, args);
	}

}

最后启动项目，输入http://localhost:8080/swagger-ui.html，就可以看得swagger为你生成的api文档了。点击Show/Hide按钮可查看或隐藏具体controller类里的api

swagger中还有很多注解，以后用到时可慢慢总结

参考：Spring Boot中使用Swagger2构建强大的RESTful API文档