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

springfox-swagger2

2.9.2

com.github.xiaoymin

swagger-bootstrap-ui

1.9.6

二、添加配置类

package com.blog.tutorial.config;

import com.git 需要zi料+ 绿色徽【vip1024b】

hub.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;

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.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

• @description:

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

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

至于这里不用swagger的参数注解，主要原因是不想加太多的注解从而增加代码的数量，造成太多冗余。搜索Java知音公众号，回复“后端面试”，送你一份Java面试题宝典.pdf

例子中的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

最后

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

[外链图片转存中…(img-yCwQugic-1710370243449)]

[外链图片转存中…(img-rTKYSuKH-1710370243450)]

[外链图片转存中…(img-wkquf8OB-1710370243451)]

[外链图片转存中…(img-hbNUy3zc-1710370243451)]