[SpringCloud]~Swagger2（在线接口文档）

简介

Swagger2是我在SpringCloud开发过程中用的最多的接口测试工具。
Swagger2是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的web服务。

POM文件

		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

启动类

需要引入注解@EnableSwagger2（如果config文件存在则在config中引入）

config文件

package com.qy.test.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
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
//@Profile({"dev", "test"})//在生产环境不开启
public class Swagger2Config implements WebMvcConfigurer {

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInf())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.qy.test.demo.controller"))//扫描位置
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("spring测试")
                .description("第一次在个人电脑搭建项目")
                .contact(new Contact("帝风科技", "https://blog.csdn.net/qq_36841482", "632883864@qq.com"))
                .version("1.0")
                .build();
    }
    
}

访问地址：http://127.0.0.1:8001/swagger-ui.html（项目路径加后缀）
展示情况如下，对照上放个字段含义。