SpringBoot之集成swagger-bootstrap-ui

 相对于传统的swager文档来说，swagger-bootstrap-ui 更具有美化样式和更适用前端开发人员的接口说明，除此还提供了文档的增强功能，这些功能是官方swagger-ui所没有的，每一个增强的功能都是贴合实际,考虑到开发者的实际开发需要,是比不可少的功能，主要包括：

• 个性化配置：通过个性化ui配置项，可自定义UI的相关显示信息

• 离线文档：根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档，通过其他第三方markdown转换工具转换成html或pdf，这样也可以放弃swagger2markdown组件

• 接口排序：自1.8.5后，ui支持了接口排序功能，例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序，step化接口操作，方便其他开发者进行接口对

SpringBoot接入流程：

1，jar引入

       
    <properties>
        <java.version>1.8</java.version>
        <swagger.version>2.9.2</swagger.version>
        <swagger-bootstrap-ui.version>1.9.6</swagger-bootstrap-ui.version>
    </properties>

 <!-- 引入swagger-ui包  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox-swagger-ui.version}</version>
        </dependency>

        <!-- 引入swagger包  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox-swagger-ui.version}</version>
        </dependency>

        <!-- 引入swagger-bootstrap-ui包 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>${swagger-bootstrap-ui.version}</version>
        </dependency>

2.SwaggerConfiguration配置类：

import org.springframework.beans.factory.annotation.Value;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Value(value = "${server.port}")
    private String serverPort;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描端口
                .apis(RequestHandlerSelectors.basePackage("com.safe.ecs"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger-bootstrap-ui RESTful APIs")
                .description("swagger-bootstrap-ui")
                .termsOfServiceUrl("http://127.0.0.1:"+serverPort+"/")
                .contact("ceshi@mail.com")
                .version("1.0")
                .build();
    }
}

4.接口加入

@RestController
@RequestMapping("/entBaseInfo")
@Api(tags = "企业信息")
public class EntBaseInfoController {


    @ApiOperation(value = "测试接口", notes = "测试接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "keyword", value = "keyword", paramType = "query", dataType = "String")})
    @GetMapping("/test")
    public void exportEntBaseInfo(@RequestParam(value = "keyword", required = false) String keyword,
                                  HttpServletResponse response) {

        List<ExportBaseInfoResp> exportList = null;

        //导出数组
        DateFormat df1 = new SimpleDateFormat("yyyyMMddHHmmss");
        String fileName = "企业列表" + df1.format(new Date());
        String titleColumn[] = new String[]{"baseInfoQymc", "baseInfoQyzcdz", "baseInfoFddbrXm", "baseInfoFddbrYddh"};
        String titleName[] = new String[]{"企业名称", "地址", "联系人", "联系电话"};
        int titleSize[] = new int[]{30, 30, 15, 15};
        //执行导出
        ExportExcelUtil.writeExcel(response, fileName, titleColumn, titleName, titleSize, exportList);
    }

}

效果如下：http://127.0.0.1:8888/ecs/doc.html（由于我这里配置了项目地址所以需要加上 /ecs）

此外  @ApiModel("企业信息添加请求类") @ApiModelProperty(value = "地址") 这两个注解还可以用在 请求参数或相应参数的的实体类上：