Java实战开发之swagger配置及访问

今天来讲讲swagger

目录

一、swagger简介及主要特点

二、swagger的配置



一、swagger简介及主要特点

Swagger 是一个流行的开源框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。它可以让开发者和用户更方便地理解和使用 API。Swagger 通过定义 RESTful API 的规范(使用 YAML 或 JSON 格式)来实现这些功能。这些规范称为 OpenAPI 规范(之前称为 Swagger 规范)。

Swagger 的主要特点包括:

  1. 自动生成 API 文档:通过分析代码中的注解,Swagger 自动生成清晰、易读的 API 文档,包括 API 的路径、参数、响应等详细信息。

  2. 交互式 API 文档:Swagger 提供了一个 Web 界面(Swagger UI),允许用户直接在浏览器中测试 API,无需编写任何代码。这使得开发者和用户能够快速了解 API 的工作原理和使用方法。

  3. 支持多种语言:Swagger 支持多种编程语言,如 Java、Python、Ruby、JavaScript 等,使得开发者可以根据自己的技能和需求选择合适的语言来开发 API。

  4. 社区支持:Swagger 拥有庞大的开发者社区,提供了丰富的资源和插件,以支持不同的框架和工具。这使得开发者可以轻松地将 Swagger 集成到现有的项目中。

  5. API 版本管理:Swagger 允许开发者在同一项目中维护多个 API 版本,方便对 API 进行迭代和更新。

二、swagger的配置

首先需要两个依赖

如果你使用的是springboot3的话

那么就只能使用以下的依赖:

XML 复制代码
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.1.0</version>
        </dependency>

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
            <version>2.1.0</version>
        </dependency>

这样才不会发生冲突

另外,springboot3的swagger不用在启动类上添加任何注解

也不用更改yml或者properties文件的任何配置即可使用

最后访问http://127.0.0.1:port/contextPath/swagger-ui/index.html

如果你是 springboot2的话建议使用如下配置

XML 复制代码
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

一个依赖即可

并在启动类上添加@EnableOpenApi注解

最后访问http://127.0.0.1:port/contextPath/swagger-ui.html

相关推荐
kangkang-1 小时前
PC端基于SpringBoot架构控制无人机(三):系统架构设计
java·架构·无人机
iCxhust2 小时前
c# U盘映像生成工具
开发语言·单片机·c#
yangzhi_emo3 小时前
ES6笔记2
开发语言·前端·javascript
界面开发小八哥3 小时前
「Java EE开发指南」如何用MyEclipse创建一个WEB项目?(三)
java·ide·java-ee·myeclipse
idolyXyz4 小时前
[java: Cleaner]-一文述之
java
一碗谦谦粉4 小时前
Maven 依赖调解的两大原则
java·maven
emplace_back4 小时前
C# 集合表达式和展开运算符 (..) 详解
开发语言·windows·c#
jz_ddk4 小时前
[学习] C语言数学库函数背后的故事:`double erf(double x)`
c语言·开发语言·学习
萧曵 丶4 小时前
Rust 所有权系统:深入浅出指南
开发语言·后端·rust