Spring Boot 集成 Swagger-Bootstrap-UI非常棒的解决方案

SpringBoot集成Swagger-Bootstrap-UI，非常棒的解决方案之前在创业公司待的时候，用过swagger，因为我第一天来这家公司工作，第一个任务就是做接口文档自动化。后来觉得它不太好用，在浏览技术网站的时候，偶然发现swagger-bootstrap-ui，于是便重构了，把swagger-bootstrap-ui整合进来，后来发现不仅仅对我们后端有帮助，主要方便我们将接口进行归类，同样对安卓小伙伴也有帮助，他们可以看这个接口文档进行联调。当初我使用swagger-boostrap-ui的时候，那个时候还是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字knife4j，适用场景从过去的单体到微服务。也算是见证咱们国人自己的开源项目从小到大。PS：如果需要Swagger相关的教程，可以关注公众号「Java后端」获取推送。该开源项目GitHub地址:/xiaoymin/Swagger-Bootstrap-UI该开源项目中文文档地址:一、添加Maven依赖<dependency>

<groupId>io.springfoxgroupId>

<artifactId>springfox-swagger2artifactId>

<version>2.9.2version>

dependency>

<dependency>

<groupId>com.github.xiaoymingroupId>

<artifactId>swagger-bootstrap-uiartifactId>

<version>1.9.6version>

dependency>二、添加配置类@Configuration

@EnableSwagger2

@EnableSwaggerBootstrapUI

publicclassSwaggerConfiguration{

@Bean

publicDocketcreateRestApi(){

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-uiRESTfulAPIs")

.description("swagger-bootstrap-ui")

.termsOfServiceUrl("http://localhost:5050/")

.contact("developer@")

.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=

"用户管理")

publicclassUserController{

@Autowired

privateUsersServiceusersService;

@GetMapping("/list")

@ApiOperation(value=

"用户列表")

publicListlist(){

return

usersService.list();

}

}五、其它补充/youcong/p/9196157.html/youcong/p/9196157.html六、可能遇到的问题1.访问不到接口文档界面白版一般是被拦截了(shiro或springsecurity机制)或者是配置错误。2.访问接口文档界面出来了，但扫描不到接口主要是配置类的缘故，配置类有个包扫描，必须配置为controller路径。如图所示:如果还有其它问题，可以去