springboot2整合swagger2构建强大的RESTful API文档

版权声明：有不足之处欢迎指出，欢迎交流 https://blog.csdn.net/qq_33594101/article/details/84797551

maven配置pom.xml

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.0.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
    
<properties>
    <springfox-swagger2-version>2.9.2</springfox-swagger2-version>
</properties>

<dependencies>
	<!--swagger2-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>${springfox-swagger2-version}</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>${springfox-swagger2-version}</version>
    </dependency>
</dependencies>

Swagger2Config.java

package zzq.config;

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;

/**
 * 〈功能简述〉<br>
 * 〈swaggerConfig〉
 *
 * @author zhouzhiqiang
 * @create 2018-12-04
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    /**
     * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     *
     * @return Docket
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("zzq.controller")).paths(PathSelectors.any())
                .build();
    }

    /**
     * api文档的详细信息函数,注意这里的注解引用的是哪个
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // //大标题
                .title("Admin RESTful API")
                // 版本号
                .version("0.0.1-SNAPSHOT")
                // 描述
                .description("API 描述")
                //作者
                .contact(new Contact("zhouzhiqiang", "https://blog.csdn.net/qq_33594101", "[email protected]"))
                .build();
    }
}

访问路径

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

swagger2常用注解使用:https://blog.csdn.net/qq_33594101/article/details/84797771
源码地址:https://github.com/18770911080/zzq