springboot集成swagger2测试接口

1.需要的依赖

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

2.开始编写一个swagger2

1.Swagger2Config配置类

package com.example.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
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;

import java.util.ArrayList;

@Configuration
@EnableSwagger2
public class Swagger2Config {



    // 配置swagger的bean实例
    @Bean
    public Docket docket(Environment environment) {
        // 设置要显示的swagger2环境
        Profiles profiles = Profiles.of("dev", "test");
        // 判断当前是否处在自己要的环境中--比如发布正式环境不开启swagger2页面
        boolean blog = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("十三")
                .apiInfo(apiInfo())
                // enable如果为false表示关闭swagger，即在浏览器中就不能访问了
                .enable(blog)
                .select()
                // basePackage:指定只扫描的包
                // any: 扫描全部
                // none: 不扫描
                // withMethodAnnotation：扫描方法上的注解
                // withClassAnnotation：扫描类上的注解
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                // 过滤demo路劲下的所有东西
//                .paths(PathSelectors.ant("/demo/**"))
                .build();
    }

    // 配置多个Docket
    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("十三-01");
    }

    @Bean
    public Docket docket2() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("十三-02");
    }

    @Bean
    public Docket docket3() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("十三-03");
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("十三", "https://www.baidu.com/", "201437@163.com");
        return new ApiInfo(
                "十三的api文档",
                "接口的测试",
                "1.0",
                "https://www.baidu.com/",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

2.User实体类

package com.example.demo.bean;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

// 使用注解给类和属性文档说明
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String userName;
    @ApiModelProperty("密码")
    private String passWord;
    @ApiModelProperty("邮箱")
    private String email;

    public User() {
    }

    public User(String userName, String passWord, String email) {
        this.userName = userName;
        this.passWord = passWord;
        this.email = email;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWord() {
        return passWord;
    }

    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

3.一个简单的controller测试类

package com.example.demo.controller;

import com.example.demo.bean.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Api(tags = "测试的接口层")
@RestController
public class TestController {

    @GetMapping("/")
    public String test() {
        return "test";
    }

    @ApiOperation("获取user实体类的接口")
    @PostMapping("/user")
    public User user(User user) {
        User userTest = new User();
        userTest.setUserName(user.getUserName());
        userTest.setPassWord(user.getPassWord());
        userTest.setEmail(user.getEmail());
        return userTest;
    }
}

4.application.properties环境的配置
PS：编写4个application.properties文件
如：application.properties—application-dev.properties—application-test.properties—application-pro.properties
文件内容如下
PS：application.properties（主配置，可根据想要显示的环境做更改）

PS：application-test.properties

PS：application-dev.properties

PS：application-pro.properties

3.演示效果图片