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

步骤一:引入 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>

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

@EnableSwagger2

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

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

修改默认显示:

controller接口方法上使用:

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

controller接口方法参数上使用:

@ApiParam(value = "用户id")

实体类字段说明使用:

@ApiModelProperty(value = "用户id")

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

字段添加了说明

接口方法参数添加说明

接口服务添加了说明

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值