2.IDEA Spring +Swagger 配置全过程

Swagger作用
 接口文档在线自动生成
 功能测试
 Swagger可以充当前后端交流的重要桥梁，方便快捷，很实用。
 提供API在线测试功能

---

直接上过程：

1.首先创建一个Spring 项目
1-1、打开IDEA - 新建项目

1-2.根据自己需求填写相关信息

1-3、选择Spring 类型

1-4、填写项目名称

2.配置Swagger Maven文件 pom.xml
2-1、在 增加Swagger 版本信息

<swagger.version>2.9.2</swagger.version>

2-2、在 增加依赖

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

3.创建Swagger配置类
3-1、配置位置

3-2、配置SwaggerConfig.java 编写（抄）代码

package com.example.demo.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
class SwaggerConfig {

    @Bean
    public Docket buildDocket() {
        return  new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())//调用下面apiInfo()方法
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))//注意这里的路径，新手容易在这里出错导致打不开。
                .paths(PathSelectors.any())
                .build();

    }
    public ApiInfo apiInfo() {
        return  new ApiInfoBuilder()
                .title("swagger2 API")
                .description("小型demo")
                .termsOfServiceUrl("http://www.163.com")//这里可以是项目地址
                .version("1.0.1")
                .build();
    }
}

4.编写一个测试类 Stu
4-1、位置

4-2、Stu代码

package com.example.demo;
//---------为了方便测试，我这里只写两个成员，并给它相庆的get set方法
public class Stu {
    private String name;
    private Integer age;

    public Stu() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

5.conteroller控制层
5-1、位置

5-2、StuController.java

package com.example.demo;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@RestController
@RequestMapping("/Stu")
public class StuController {
    static Map<Integer , Stu> map = new ConcurrentHashMap<>();
    @ApiOperation(value = "获取学生信息列表1")
    @RequestMapping(value = "",method = RequestMethod.GET)
    public List<Stu> getList() {
        List<Stu> list = new ArrayList<>(map.values());
        return  list;
    }

    @ApiOperation(value = "创建学生" , notes = "根据stu对象创建")
    @ApiImplicitParam(name = "Stu",value = "详情实体类",required = true,dataType = "Stu")
    @RequestMapping(value = "",method = RequestMethod.POST)
    public String postUser(@RequestBody Stu stu) {
        map.put(stu.getAge(),stu);
        return "添加成功~~~";
    }
}

6.运行
打开地址
http://localhost:8080/swagger-ui.html#

原创不易，分享请注明出处。