集成Swagger文档

 1. 在pom文件内添加Maven依赖,这里选择3.0.0版本

<!--        swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

 2. 启动类上加上注解@EnableOpenApi

@SpringBootApplication
@EnableOpenApi
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class,args);
    }
}

3. 浏览器输入链接:localhost:8080/swagger-ui/index.html(端口号根据自己设置的写)

http://localhost:8080/swagger-ui/index.html

 4. 显示如下界面即配置成功:

5. 使用Swagger集成文档具有以下几个优势: 

  • 功能丰富:支持多种注解,自动生成接口文档界面,支持在界面测试API接口功能。
  • 及时更新:开发过程中花一点写注释的时间,就可以及时地更新API文档,省心省力。
  • 整合简单:通过添加pom依赖和简单配置,内嵌于应用中就可同时发布API接口文档界面,不需要部署独立服务。
     

6. 官方网站:https://swagger.io/
官方文档:https://swagger.io/docs/

7. 参考书籍:

[1]徐立建.SpringBoot+SpringCloud+Vue+Element项目实战:手把手教你开发权限管理系统[M].北京:清华大学出版社.

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

前途无量的彪哥

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

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

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

打赏作者

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

抵扣说明:

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

余额充值