Spring Cloud 之 Knife4j集成（八）

java開發的小伙伴對swagger並不陌生，swagger節省了開發人員很多時間，但是筆者在使用的時候總覺得欠缺點什么，就是它的“非國人”UI。看起來十分不爽，相比於swagger，JApiDocs看起來更符合國人的審美觀。但是JApiDocs缺不能像swagger一樣在線調試。而Knife4j解決了這一問題，它不但能在線調試接口，還有國人審美觀的UI。

 

Knife4j的前身是swagger-bootstrap-ui，為了契合微服務的架構發展，由於原來swagger-bootstrap-ui采用的是后端Java代碼+前端Ui混合打包的方式，在微服務架構下顯的很臃腫,因此項目正式更名為knife4j。

Knife4j源碼：https://github.com/xiaoymin/swagger-bootstrap-ui

Knife4j Demo源碼：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

廢話不多說，開搞！！！

 

我們仍然在之前搭建的x-demo-service基礎上集成Knife4j

1、修改根項目spring-cloud-x的build.gradle配置文件，第4行增加knife4j依賴。

    dependencyManagement {
        imports { mavenBom("org.springframework.boot:spring-boot-dependencies:${springBootVersion}") }
        imports { mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" }
        imports { mavenBom "com.github.xiaoymin:knife4j-dependencies:2.0.5" }
    }

 

2、修改子模塊x-demo-service的build.gradle文件，增加knife4j-spring-boot-starter依賴

dependencies {
    compile project(":x-demo-service-api")

    compile("org.springframework.cloud:spring-cloud-starter-netflix-eureka-client")
    compile("com.github.xiaoymin:knife4j-spring-boot-starter")
}

 

3、新建Knife4j配置JAVA類

/**
 * @author Leo
 */
@EnableSwagger2
@EnableKnife4j
@Configuration
public class Knife4jConfig {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("這是一個分組名稱")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.x.demo.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("x-demo-service接口文檔")
                .description("x-demo-service接口文檔")
                .termsOfServiceUrl("https://www.cnblogs.com/shileibrave/")
                .contact(new Contact("Leo", "https://www.cnblogs.com/shileibrave/", "[e-mail]"))
                .version("1.0")
                .build();
    }
}

 

4、修改Controller類

修改了第4行，第12行。@Api和@ApiOperation都是swagger注解，不明白swagger注解的自己惡補吧。

/**
 * @author Leo
 */
@Api(tags = "DemoApiProviderController")
@RestController
@Slf4j
public class DemoApiProviderController implements ServiceDemoApi {

    @Value("${server.port}")
    String port;

    @ApiOperation(value = "sayHello接口")
    @Override
    public BaseResponse sayHello(BaseRequest request) {
        BaseResponse response = new BaseResponse();
        response.setCode("0000");
        response.setMessage("success");
        response.setData("ServiceDemoApi: " + port);
        return response;
    }
}

 

5、重啟x-demo-service服務

在瀏覽器中輸入：http://localhost:8081/doc.html，Knife4j主頁

 

 

查看sayHello接口文檔

 

 

調試sayHello接口

 

 

到此單體服務集成Knife4j完成，后面將SpringCloud網關的時候，再說一下網關和Knife4j如何集成。