关于vue.js:SpringCloud微服务实战搭建企业级开发框架六使用knife4j集成Swagger2接口文档

  knife4j是为集成Swagger生成api文档的加强解决方案，前后端Java代码以及前端Ui模块进行拆散,在微服务架构下应用更加灵便，
提供专一于Swagger的加强解决方案,不同于只是改善加强前端Ui局部，咱们这里应用knife4j作为文档管理工具来代替swagger-ui。

1、在GitEgg-Platform工程下新建gitegg-platform-swagger子工程，在GigEgg-Platform中的子工程gitegg-platform-bom中，批改pom
.xml，以maven bom的形式应用knife4j:

            <!-- Swagger2 knife4j bom形式引入 -->            <dependency>                <groupId>com.github.xiaoymin</groupId>                <artifactId>knife4j-dependencies</artifactId>                <version>${knife4j.version}</version>                <type>pom</type>                <scope>import</scope>            </dependency>

2、在gitegg-platform-swagger子工程中的pom.xml增加knife4j援用：

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0"         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <parent>        <artifactId>GitEgg-Platform</artifactId>        <groupId>com.gitegg.platform</groupId>        <version>1.0-SNAPSHOT</version>    </parent>    <modelVersion>4.0.0</modelVersion>    <artifactId>gitegg-platform-swagger</artifactId>    <name>${project.artifactId}</name>    <version>${project.parent.version}</version>    <packaging>jar</packaging>    <dependencies>        <dependency>            <groupId>com.github.xiaoymin</groupId>            <artifactId>knife4j-spring-boot-starter</artifactId>        </dependency>    </dependencies></project>

3、在gitegg-platform-swagger子工程中新建SwaggerConfig.java文件：

package com.gitegg.platform.swagger.config;import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Import;import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;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@EnableKnife4j@Import(BeanValidatorPluginsConfiguration.class)public class SwaggerConfig {    @Bean(value = "GitEggApi")    public Docket GitEggApi() {        Docket docket=new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                //分组名称                .groupName("2.X版本")                .select()                //这里指定Controller扫描包门路                .apis(RequestHandlerSelectors.basePackage("com.gitegg.*.*.controller"))                .paths(PathSelectors.any())                .build();        return docket;    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder().version("1.0.0")                .title("Spring Cloud Swagger2 文档")                .description("Spring Cloud Swagger2 文档")                .termsOfServiceUrl("www.gitegg.com")                .build();    }}

4、在gitegg-service工程中引入gitegg-platform-swagger

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0"         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <parent>        <artifactId>GitEgg-Cloud</artifactId>        <groupId>com.gitegg.cloud</groupId>        <version>1.0-SNAPSHOT</version>    </parent>    <modelVersion>4.0.0</modelVersion>    <artifactId>gitegg-service</artifactId>    <packaging>pom</packaging>    <modules>        <module>gitegg-service-base</module>        <module>gitegg-service-bigdata</module>        <module>gitegg-service-system</module>    </modules>    <dependencies>        <!-- gitegg数据库驱动及连接池 -->        <dependency>            <groupId>com.gitegg.platform</groupId>            <artifactId>gitegg-platform-db</artifactId>        </dependency>        <!-- gitegg mybatis-plus -->        <dependency>            <groupId>com.gitegg.platform</groupId>            <artifactId>gitegg-platform-mybatis</artifactId>        </dependency>        <!-- gitegg swagger2-knife4j -->        <dependency>            <groupId>com.gitegg.platform</groupId>            <artifactId>gitegg-platform-swagger</artifactId>        </dependency>        <!-- spring boot web外围包 -->        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>        <!-- spring boot 衰弱监控 -->        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-actuator</artifactId>        </dependency>    </dependencies></project>

5、在gitegg-service-system工程下的SystemController.java类外面增加Swagger2相干注解

package com.gitegg.service.system.controller;import com.gitegg.service.system.service.ISystemService;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import lombok.AllArgsConstructor;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestController@RequestMapping(value = "system")@AllArgsConstructor@Api(tags = "gitegg-system")public class SystemController {    private final ISystemService systemService;    @GetMapping(value = "list")    @ApiOperation(value = "system list接口")    public Object list() {        return systemService.list();    }    @GetMapping(value = "page")    @ApiOperation(value = "system page接口")    public Object page() {        return systemService.page();    }}

6、GitEggSystemApplication.java退出组件扫描的注解，让Spring在启动的时候加载到swagger2的配置:

package com.gitegg.service.system;import org.mybatis.spring.annotation.MapperScan;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.ComponentScan;/** * gitegg-system 启动类 */@ComponentScan(basePackages = "com.gitegg")@MapperScan("com.gitegg.*.*.mapper")@SpringBootApplicationpublic class GitEggSystemApplication {    public static void main(String[] args) {        SpringApplication.run(GitEggSystemApplication.class,args);    }}

7、运行gitegg-service-system，关上浏览器拜访：http://127.0.0.1:8001/doc.html，能够看到swagger2文档界面

本文源码在https://gitee.com/wmz1930/GitEgg 的chapter-06分支。