swagger 增强UI --knife4j

knife4j

文档：  https://gitee.com/xiaoym/knife4j

(1)简介

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

(2)核心功能

该UI增强包主要包括两大核心功能：文档说明 和 在线调试

• 文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。

• 在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。

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

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

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

使用：

  依赖：（不需要单独导入swagger的依赖）

    <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.6</version>
        </dependency>

配置：

@EnableKnife4j
@Configuration
@EnableSwagger2WebMvc
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Config {
    //Swagger configuration
    public static final String API_CONTROLLER_PACKAGE_PATH = "com.sea";
    public static final String SYSTEM_SUPPORT_NAME="SEA-SUPPORT";
    public static final String SYSTEM_SUPPORT_MAIL = "sea_sup@sea.net" ;
    public static final String API_NAME="SEA-DEP-SERVICE RESTful APIs";
    public static final String SYSTEM_DOMAIN_NAME="http://www.sea.com/";
    public static final String API_DESCRIPTION = "The RESTful APIS in SEA-DEP-SERVICE";

      @Bean
        public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage(API_CONTROLLER_PACKAGE_PATH))
//                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any())
                    .build();
        }

        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title(API_NAME)
                    .description(API_DESCRIPTION)
                    .termsOfServiceUrl(SYSTEM_DOMAIN_NAME)
                    .contact(new Contact(SYSTEM_SUPPORT_NAME, "", SYSTEM_SUPPORT_MAIL))
                    .build();
        }
}

具体使用和Swagger 一样一样。

打开UI

http://localhost:port/doc.html