Spring Boot 集成 Swagger-Bootstrap-UI 已完成-Java-E先生的博客
Java
MySQL
大数据
Python
前端
黑科技
大语言模型
    首页 >> 互联网 >> Java

Spring Boot 集成 Swagger-Bootstrap-UI 已完成

[导读]:当初我使用swagger-boostrap-ui的时候,那个时候还是1.x版本,如今swagger-bootsrap-ui到2.x,同时也更改名字knife4j,适用场景从过去的单体到微服务。也算是见证咱们国人自己的开源项目从小到大。 一...
  当初我使用swagger-boostrap-ui的时候,那个时候还是1.x版本,如今swagger-bootsrap-ui到2.x,同时也更改名字knife4j,适用场景从过去的单体到微服务。也算是见证咱们国人自己的开源项目从小到大。
  一、添加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
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 list() {
        return usersService.list();
    }
}
  五、其它补充
  https://www.yanxias.com/Java/121.html
  六、可能遇到的问题
  1.访问不到接口文档界面白版
  一般是被拦截了(shiro或springsecurity机制)或者是配置错误。
  2.访问接口文档界面出来了,但扫描不到接口
  主要是配置类的缘故,配置类有个包扫描,必须配置为controller路径。如图所示:
  
  如果还有其它问题,可以去官方文档上找,官方文档有一个常规问题列表和解决方案,如图所示:
  
  如果问题非常奇葩的话,实在解决不了(在参考官方文档说明和搜索的前提下,仍解决不了,把问题详细描述和关键性代码提交留言 交给作者)。

本文来自E先生的博客,如若转载,请注明出处:https://www.javajz.cn

留言区

联系人:
手   机:
内   容:
验证码:

历史留言

欢迎加Easy的QQ