Swagger2配置

Swagger2

Swagger2简介

• Swagger 是一个规范和完整的框架，用于生成、描述、功能调用测试和可视化 RESTful 风格的在线的接口文档工具。

• Swagger 是一套基于 OpenAPI 规范（OpenAPI Specification，OAS）构建的开源工具。

• Swagger 提供了一套通过代码和注解自动生成可视化的 RESTful 风格的API文档，符合 RESTful API设计的行业标准。

pom文件

  <!-- swagger2 配置 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>

Swagger2代码实现

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 Swagger2 {

    // http://localhost:8088/swagger-ui.html 原路径
    // http://localhost:8088/doc.html 路径


    // 配置Swagger2核心配置 docket
    @Bean
    public Docket createRestApi(){

        return new Docket(DocumentationType.SWAGGER_2)//指定api类型为Swagger2
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors
                        .basePackage("com.saddan.controller")) //指定controller包
                .paths(PathSelectors.any()) //所有controller
                .build();

    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("xxx平台接口api")    //文档页标题
                .contact(new Contact(
                        "saddam",
                        "https://www.xxx.com",
                        "abc@imooc.com")) //联系人信息
                .description("专为xxx提供的api文档") //详细信息
                .version("1.0.1") //文档版本号
                .termsOfServiceUrl("https://www.xxx.com") //网站地址
                .build();

    }
}

可视化界面

http://localhost:8088/swagger-ui.html
http://localhost:8088/doc.html