SpirngBoot2.x整合Swagger2接口文档

一、引入Jar包

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

 

二、配置类

package com.liangjian.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;

/**
 * swagger2接口测试
 */

@Configuration
@EnableSwagger2
public class Swagger2Config {

        //启动项目swagger访问地址;http://localhost:8080/swagger-ui.html#/

        //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    //为当前包路径
                    .apis(RequestHandlerSelectors.basePackage("com.liangjian.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
        //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    //页面标题
                    .title("影院后台接口文档")
                    //创建人
                    .contact(new Contact("cookie", "XXXXXXX", "1092249319@qq.com"))
                    //版本号
                    .version("0.0.1")
                    //描述
                    .description("测试接口")
                    .build();
        }

    }

 

三、application.yml

server:
  port: 8080
  servlet:
    context-path: /demo

 

四、启动项目swagger访问地址;http://localhost:8080/demo/swagger-ui.html