knife4j的使用

knife4j

knife4j的前世今生，我们不作细究，感兴趣的朋友可以去 官网 一探究竟。本文只是记录简单的使用方法，以便快速入手。

使用

swagger2的使用

由于knife4j本就是需要swagger2支持，所以奉上swagger2学习地址：
https://www.ibm.com/developerworks/cn/java/j-using-swagger-in-a-spring-boot-project/index.html

Spring Boot 单服务架构

1. 增加依赖

    com.github.xiaoymin
    knife4j-spring-boot-starter
    
    2.0.2

knife4j-spring-boot-starter 主要为我们引用的相关jar包：

• knife4j-spring:Swagger增强处理类
• knife4j-spring-ui:swagger的增强ui文档
• springfox-swagger:springfox最新2.9.2版本
• springfox-swagger-ui:springfox提供的ui
• springfox-bean-validators：springfxo验证支持组件

2. 创建配置文件

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
     
	@Bean
    public Docket api() {
     
        return new Docket(DocumentationType.SWAGGER_2)      // 选择swagger2版本
                .apiInfo(apiInfo())         //定义api文档汇总信息
                .select()
                .apis(RequestHandlerSelectors
                        .basePackage("com.dave.controller"))  // 指定生成api文档的包
                .paths(PathSelectors.any())     // 指定所有路径
                .build()
                ;
    }

    /**
     * 构建文档api信息
     * @return
     */
    private ApiInfo apiInfo() {
     
        return new ApiInfoBuilder()
                .title("文档标题")     // 文档标题
                .contact(new Contact("name", "url", "mail"))   //联系人信息
                .description("描述")      //描述
                .version("0.1")     //文档版本号
                .termsOfServiceUrl("http://localhost:8080")     //网站地址
                .build();
    }
}

3. 访问 http://localhost:8080/doc.html 即可见到knife4j的api文档页面页面