swagger简单使用

最新推荐文章于 2024-10-20 12:38:33 发布

原创最新推荐文章于 2024-10-20 12:38:33 发布 · 117 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring boot

Swagger是一款强大的API文档在线生成和测试工具，能够帮助开发者实时更新接口文档，简化接口调试过程。通过在SpringBoot项目中引入Swagger依赖并启用相关配置，可以将接口以列表形式展示，并提供直接调用接口的功能，降低测试数据准备成本。此外，Swagger-ui还支持与应用集成，无需手动导入接口定义，使得接口管理变得更加便捷。

什么是swagger

API文档在线生成工具
API接口在线测试工具
相当于在线版postman

swagger的好处

将项目中对外提供的接口以列表形式展现在页面上，后端不需要再编写专门的接口文档；
接口更新后，只需要修改代码中的Swagger注解描述，就会实时更新接口文档，不需要再手动维护接口文档；
通过Swagger-ui页面，可以直接调用接口，降低了开发阶段的调试难度；
Swagger-ui页面调用接口时，自动生成了入参数据结构，减少了测试数据准备时间成本；
可以与应用集成，不需要手动导入接口定义
没有本地客户端，使用方便

如何使用swagger

引入依赖

以spring boot项目为例，在pom.xml中引入如下信息

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

或者

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>