集成swagger

baizonghao

2023-06-07 5ed52a7f41478c0709a356774a640957b811f472

集成swagger

 xzs/pom.xml

@@ -106,7 +106,22 @@
            <version>1.2.12</version>
        </dependency>


        <!--swagger 依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>

 xzs/src/main/java/com/mindskip/xzs/aop/InterfaceLogHandler.java

File was deleted

 xzs/src/main/java/com/mindskip/xzs/configuration/spring/mvc/WebMvcConfiguration.java

@@ -45,6 +45,11 @@
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/")
                .setCachePeriod(31556926);
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }

    @Override

 xzs/src/main/java/com/mindskip/xzs/configuration/swagger/SwaggerConfig.java

New file
@@ -0,0 +1,42 @@
package com.mindskip.xzs.configuration.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).
                // 指定构建 api 文档的详细信息的方法：
                        apiInfo(apiInfo()).apiInfo(apiInfo()).select()
                // 指定要生成 api 接口的包路径，这里把 controller 作为包路径，生成 controller 中的所有接口
                .apis(RequestHandlerSelectors.basePackage("com.mindskip.xzs.controller")).paths(PathSelectors.any()).build();
    }

    /**
     * 构建 api 文档的详细信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("后台接口文档").contact(new Contact("青羊考试系统", "", ""))
                // 设置接口描述
                .description("Api文档: 注意!! Date格式: yyyy-MM-dd HH:mm:ss")
                // 设置版本
                .version("1.0")
                // 构建
                .build();
    }
}