springboot 2.0配置swagger2

swagger2，springboot自动生成API接口文档，还可以模拟调用（类似于postman）

一、目录结构

二、pom.xml引入

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

三、Swagger2.java

package com.urthink.upfs.springbootswagger2.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;

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.urthink.upfs.springbootswagger2"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("API描述")
                .termsOfServiceUrl("http://www.urthink.com/")
                .contact(new Contact("admin", "http://www.urthink.com", "admin@urthink.com"))
                .version("1.0")
                .build();
    }
}

四、DemoController.java

package com.urthink.upfs.springbootswagger2.controller;


import com.urthink.upfs.springbootswagger2.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

/**
 * 样例Controller
 *
 * @author zhao
 * @date 2019.2.27
 */
@RestController
@RequestMapping("/demo")
@Api(value = "DemoController", tags = {"DemoController说明"}) //可以不写
public class DemoController {

    @ApiOperation(value = "测试方法1", notes = "测试方法1的notes") //可以不写
    @RequestMapping(value = "/test1", method = RequestMethod.GET)
    public String test1() {
        return "测试1";
    }

    @ApiOperation(value = "1参数", notes = "回显字符串") //可以不写
    @ApiImplicitParam(name = "str1", value = "字符串1", required = true, dataType = "String")//可以不写
    @RequestMapping(value = "/show", method = RequestMethod.GET)
    public String add(@RequestParam String str1) {
        return str1;
    }

    @ApiOperation(value = "2参数", notes = "字符串相加")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "str1", value = "字符串1", required = true, dataType = "String"),
            @ApiImplicitParam(name = "str2", value = "字符串2", required = true, dataType = "String")
    })
    @RequestMapping(value = "/concat", method = RequestMethod.GET)
    public String concat(@RequestParam String str1, @RequestParam String str2) {
        return str1 + str2;
    }

    @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") //dataType="Integer"没法调用？
    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public User getUser(@PathVariable Integer id) {
        User user = new User();
        user.setId(id.intValue());
        user.setName("admin");
        return user;
    }


    @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public String putUser(@PathVariable Integer id, @RequestBody User user) {
        System.out.println(user.getId());
        System.out.println(user.getName());
        return "success";
    }

    //上传文件
    @RequestMapping(value = "/import", method = RequestMethod.POST)
    public String excelImport(@RequestParam("file") MultipartFile excel) {
        return excel.getOriginalFilename();
    }

}

五、User.java

package com.urthink.upfs.springbootswagger2.entity;

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

import java.io.Serializable;

//@ApiModel(value = "User实体类") //可以不写（要和引用的地方对应）
public class User implements Serializable {

    private Integer id;

    @ApiModelProperty(value="姓名",required = true) //可以不写
    private String name;


    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

六、SpringbootSwagger2Application

package com.urthink.upfs.springbootswagger2;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * http://localhost:8080/swagger-ui.html
 */
@SpringBootApplication
public class SpringbootSwagger2Application {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwagger2Application.class, args);
    }

}

七、访问效果

1.访问http://localhost:8080/swagger-ui.html

2.点开一个接口，点击Try it out，输入参数，点击Execute，查看输出结果

3.请求参数是实体类类型的，可以上送json格式数据

4.还可以测试上传文件

swagger还可以配置成需要登录访问的，自行百度吧

参考：

swagger2常用注解说明
https://blog.csdn.net/u014231523/article/details/76522486