spring boot 引入swagger

访问路径: http://localhost:端口号/swagger-ui.html

引入POM依赖

<!--swagger : 访问 http://localhost:端口号/swagger-ui.html-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version> // 版本号可以换成最新的
        </dependency>
<!--swagger-ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>  // 版本号可以换成最新的
        </dependency>

在启动类添加注解: @EnableSwagger2

@EnableSwagger2 是springfox提供的注解,代表swagger2相关技术启动。会扫描当前类所在包,及子包中所有类型的swagger相关注解,做swagger文档的定制。

*:1.什么是springfox?
  springfox:是一个开源的API Doc的框架,前身swagger-springmvc,可以将Controller中的方法按照文档的形式进行展现。
  2.什么是swagger?
  swagger:是一个规范完整的框架,用于生成、描述、调用和可视化Restful风格的web服务。
  3.springfox作用:
  3.1:使前后端更加解耦。
  3.2可以生成接口文档,解决写接口文档的痛苦。
  3.3支持在线测试,可以实时检查参数和返回值。

在Controller添加@API

用于控制整个类生成的接口信息的内容
属性:
tags:类的名称。
description:描述。已过时
例: @Api(value = "个人基本信息查询系统",tags = "个人基本信息查询系统")

在方法添加@ApiOperation

方法上的注解,描述方法的相关信息。
属性:
value:方法描述作用
notes:方法笔记(描述): @ApiOperation(value = "查询基本信息",notes = "查询基本信息")
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

大众筹码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值