Spring Boot 集成 Swagger-Bootstrap-UI 已完成-Java-阿习进阶博客

　　当初我使用swagger-boostrap-ui的时候，那个时候还是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字knife4j，适用场景从过去的单体到微服务。也算是见证咱们国人自己的开源项目从小到大。

　　一、添加Maven依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

　　二、添加配置类

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfiguration {
    @Bean
public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.blog.tutorial.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger-bootstrap-ui RESTful APIs")
                .description("swagger-bootstrap-ui")
                .termsOfServiceUrl("http://localhost:5050/")
                .contact("developer@mail.com")
                .version("1.0")
                .build();
    }
}

　　三、启动项目

　　启动项目，不报错，然后访问地址:http://ip:port/doc.html即可,效果图，如下:

　　测试接口，效果图如下:

　　调式相当于用PostMan测试接口。

　　四、常用注解

　　和swagger一样，swagger用的注解，swagger-bootstrap-ui仍能用。不过结合我的开发经验来看，最常用的也就两个， Api和 ApiOperation。 Api的效果，如图:

　　 ApiOperation的效果，如图:

　　由此，我们很容易就看出来，它们的含义是什么，一个是接口分类说明，一个是接口方法说明。

　　至于这里不用swagger的参数注解，主要原因是不想加太多的注解从而增加代码的数量，造成太多冗余。

　　例子中的Controller代码:

@RestController
@RequestMapping("/user")
@Api(tags = {"用户管理"}, description = "用户管理")
public class UserController {
    @Autowired
private UsersService usersService;
    @GetMapping("/list")
    @ApiOperation(value = "用户列表")
    public List<Users> list() {
        return usersService.list();
    }
}