SpringBoot集成Swagger-Bootstrap-UI，页面更清爽！

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
* @author: youcong

* @time: 2020/11/14 15:46

*/@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的效果，如图:

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

例子中的Controller代码:

package com.blog.tutorial.controller;

import com.blog.tutorial.entity.Users;

import com.blog.tutorial.service.UsersService;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**

* @description:

* @author: youcong

* @time: 2020/11/14 13:27

*/@RestController

@RequestMapping(“/user”)

@Api(tags = {“用户管理”}, description = “用户管理”)

public class UserController {

@Autowired

private UsersService usersService;

@GetMapping(“/list”)

@ApiOperation(value = “用户列表”)

public List list() {

return usersService.list();

}

}

五、其它

---

关于swagger整合系列，可以参考如下:

https://www.cnblogs.com/youcong/p/9011302.html

关于swagger-bootstrap整合系列，可以参考:

https://www.cnblogs.com/youcong/p/9196157.html

https://www.cnblogs.com/youcong/p/10786371.html

六、可能遇到的问题

---

1.访问不到接口文档界面白版

一般是被拦截了(shiro或springsecurity机制)或者是配置错误。

2.访问接口文档界面出来了，但扫描不到接口

主要是配置类的缘故，配置类有个包扫描，必须配置为controller路径。

如图所示:

如果还有其它问题，可以去官方文档上找，官方文档有一个常规问题列表和解决方案，如图所示:

最后

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
[外链图片转存中…(img-TASfY4ku-1714671391608)]

[外链图片转存中…(img-t2aKgqn8-1714671391608)]

[外链图片转存中…(img-W7OKWjqO-1714671391608)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！