springboot轻松配置swagger

最新推荐文章于 2024-07-12 10:03:43 发布

Hc灬cH

最新推荐文章于 2024-07-12 10:03:43 发布

阅读量665

点赞数 1

文章标签： spring boot

本文链接：https://blog.csdn.net/Ver_rev/article/details/126370998

版权

本文介绍了如何在Spring Boot项目中集成Swagger，包括Swagger的作用和使用步骤。Swagger是一个用于生成、展示和测试RESTful接口的工具，它可以帮助开发者创建接口文档并允许直接在页面上进行接口调用和测试，简化了接口管理和调试过程。

摘要由CSDN通过智能技术生成

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

前言
一、Swagger是什么？
二、使用步骤
- 1.pom导入swagger包以及knief
- 2.添加swagger配置类
总结

前言

本文针对springboot项目轻松引入swagger做一个示例。

一、Swagger是什么？

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。 PS：Swagger 遵循了 OpenAPI 规范，OpenAPI 是 Linux 基金会的一个项目，试图通过定义一种用来描述 API 格式或 API 定义的语言，来规范 RESTful 服务开发过程。 Swagger 官网地址：https://swagger.io/Swagger 有什么用？从上述 Swagger 定义我们不难看出 Swagger 有以下 3 个重要的作用：将项目中所有的接口展现在页面上，这样后端程序员就不需要专门为前端使用者编写专门的接口文档；当接口更新之后，只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了，从而规避了接口文档老旧不能使用的问题；通过 Swagger 页面，我们可以直接进行接口调用，降低了项目开发阶段的调试成本。

二、使用步骤

1.pom导入swagger包以及knief

代码如下（示例）：

    <properties>
        <swagger.version>2.9.2</swagger.version>
        <knife4j.version>2.0.2</knife4j.version>
    </properties>
<!-- 在dependencies标签下添加如下， knife，是 swagger 的增强版，同一个作者开发。该UI增强包主要包括两大核心功能：文档说明 和 在线调试  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId