knife4j swagger API文檔

swagger-bootstrap-ui 升級為 knife4j

1. 官方文檔

　　　　https://doc.xiaominfo.com/knife4j/documentation/get_start.html

　　  2. demo地址:

　　　　https://gitee.com/xiaoym/swagger-bootstrap-ui-demo/tree/master/knife4j-spring-boot-fast-demo

　　  3. 在maven項目的pom.xml中引入Knife4j的依賴包，代碼如下：

　　　　

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.7</version>
</dependency>

　　

　　  4. 創建Swagger配置依賴，代碼如下：

　　　　

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("[e-mail]")
                        .version("1.0")
                        .build())
                //分組名稱
                .groupName("2.X版本")
                .select()
                //這里指定Controller掃描包路徑
                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

　　5. 啟動SpringBoot項目即可看到http://ip:port/path/doc.html

　　示例: http://localhost:8080/api/doc.html

 

　　6. knife4j 對於swagger-bootstrap-ui

　　后端Java代碼和ui包分離為多個模塊的jar包,以面對在目前微服務架構下,更加方便的使用增強文檔注解(使用SpringCloud微服務項目,只需要在網關層集成UI的jar包即可,因此分離前后端)

　　然后增加了直接下載文檔功能(可以下載md,html,word,openAPI,pdf)