API神器——Swagger3.0零配置启动

Swagger3.0时代到来

在前后端分离的大趋势下，API接口文档是二者沟通的关键文档，于是乎就有了Swagger这个可以自动生成API接口文档的框架，奈何，在SpringBoot中使用Swagger时，需要添加两个jar包，还要进行手动的配置，实属有点繁琐，但是现在：

Swagger 3.0 的官方starter 已经发布了，使用starter我们便可以更加方便快捷的将Swagger集成到项目中，而不需要进行过多的配置，省去一堆麻烦事情。

在pom.xml中添加Swagger3.0 Starter

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

在项目中写好controller

@RestController
@RequestMapping("/oss")
@Api(value = "mybatis-swagger示例接口", description = "用来演示示例接口注解")
public class TestController {


    @ApiOperation(value="修改用户密码", notes="根据用户id修改密码")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType="query", name = "userId", value = "用户ID", required = true, dataType = "Integer"),
            @ApiImplicitParam(paramType="query", name = "password", value = "旧密码", required = true, dataType = "String"),
            @ApiImplicitParam(paramType="query", name = "newPassword", value = "新密码", required = true, dataType = "String")
    })
    @RequestMapping("/updatePassword")
    public String updatePassword(@RequestParam(value="userId") Integer userId, @RequestParam(value="password") String password,
                                 @RequestParam(value="newPassword") String newPassword){
        if(userId <= 0 || userId > 2){
            return "未知的用户";
        }
        if(StringUtils.isEmpty(password) || StringUtils.isEmpty(newPassword)){
            return "密码不能为空";
        }
        if(password.equals(newPassword)){
            return "新旧密码不能相同";
        }
        return "密码修改成功!";
    }
}

访问swagger

http://localhost:8080/swagger-ui/

干脆利落~~~~