swagger-springboot使用

swagger-springboot

首先创建一个初始化的springboot项目，创建结果如下：
在pom文件中引入以下依赖

<!--整合Swagger-->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

配置swagger的配置类

package com.fei.swagger.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
}

启动springboot项目登录以下网址：

http://localhost:8080/swagger-ui.html
如下页面启动成功：

接下来详细配置swagger参数：

package com.fei.swagger.controller;

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.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Api(value = "API - TestController", description = "测试类")
@RestController
public class TestController {

    @ApiOperation(value = "API - TestController - testSwagger", notes = "测试类测试方法")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "no", value = "测试参数")
    })
    @GetMapping("/testSwagger")
    public String testSwagger(@RequestParam(value = "no", required = false) String no){
        return "测试方法返回值:"+no;
    }

}

具体可以配置的参数参照官网：
https://gumutianqi1.gitbooks.io/specification-doc/content/tools-doc/spring-boot-swagger2-guide.html
参数配置完毕后重启项目登录：
http://localhost:8080/swagger-ui.html

swagger和springboot结合配置成功。