Swagger api自动生成

swagger简介

swagger使用

第一步：配置并启用swagger

在 jboot.properties上添加如下配置：

jboot.swagger.path=/swaggerui
jboot.swagger.title=Jboot API 测试
jboot.swagger.description=这真的真的真的只是一个测试而已，不要当真。
jboot.swagger.version=1.0
jboot.swagger.termsOfService=http://jboot.io
jboot.swagger.contact=email:fuhai999@gmail.com;qq:123456
jboot.swagger.host=127.0.0.1:8080

第二步：下载swagger ui放到resource目录下

注意，这里一定要放在resource的 swaggerui 目录，因为以上的配置中是jboot.swagger.path=/swaggerui,当然可以通过这个配置来修改这个存放目录。

另：swagger ui 的下载地址是：https://github.com/swagger-api/swagger-ui，下载其 dist 目录即可，只需要这个目录里的文件。

第三步：通过注解配置Controller的api

代码如下：

@RequestMapping("/swaggerTest")
@Api(description = "用户相关接口文档", basePath = "/swaggerTest", tags = "abc")
public class MySwaggerTestController extends JbootController {
    @ApiOperation(value = "用户列表", httpMethod = "GET", notes = "user list")
    public void index() {
        renderJson(Ret.ok("k1", "v1").set("name", getPara("name")));
    }
    @ApiOperation(value = "添加用户", httpMethod = "POST", notes = "add user")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用户名", paramType = "form", dataType = "string", required = true),
            @ApiImplicitParam(name = "k1", value = "k1", paramType = "form", dataType = "string", required = true),
    })
    public void add(String username) {
        renderJson(Ret.ok("k1", "v1").set("username", username));
    }
}

第四步：浏览器访问swagger生成api文档

在第一步的配置中，因为jboot.swagger.path=/swaggerui，所以我们访问如下地址：http://127.0.0.1:8080/swaggerui 效果如下图所示。

图片1

图片2

在图片2中，我们可以输入参数，并点击 Execute 按钮进行测试。