( 九 )使用swagger自动生成html接口文档

步骤一:引入 swagger 依赖

        
        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        

步骤二:在需要生成文档的接口上使用注解

@EnableSwagger2

接下来就可以访问默认的接口文档了,只不过都是英文的,字段没有说明

访问地址:http://ip:port/swagger-ui.html

修改默认显示:

controller接口方法上使用:

@ApiOperation(value = "查询单个用户服务")

controller接口方法参数上使用:

@ApiParam(value = "用户id")

实体类字段说明使用:

@ApiModelProperty(value = "用户id")

接下来再次访问就可以显示想要的效果了:

字段添加了说明

接口方法参数添加说明

接口服务添加了说明

你可能感兴趣的:(swagger,自动生成接口文档,RestFul)