Swagger API文档基于SpringBoot 3.x集成SpringDoc框架

文章结构概述

• 常规方式

  • • 第 1 步：引入所需依赖库

    • 第 2 步：设置 API 接口信息与全局配置参数

    • • 配置 OpenAPI 文档说明
      • • 单个 OpenAPI 文档配置 - 方法 1

    • 单个 OpenAPI 文档配置 - 方法 2

    • 多个 OpenAPI 文档的配置方式

      • 其它 SpringDoc 及 Swagger-UI 相关设置

    • 第 3 步：引入 Swagger3 注解标识

    • • 对比 Swagger2 与 Swagger3 注解的对应关系
      • Swagger3 注解使用示例
      • • Feign 客户端及其对应的 Controller 实现类

    • 常用 Response 返回结构与 Account 实体类定义

    • 界面展示效果

  • 特殊方式 1：依据 JavaDoc 自动生成 API 描述信息

  • • 第 1 步：引入相关依赖项
    • 第 2 步：执行项目编译操作
    • 第 3 步：在代码中添加 JavaDoc 格式的注释内容
    • 第 4 步：查看最终生成的 API 展示结果

  • 特殊方式 2：在构建过程中自动生成 JSON/YAML 格式文档

  • 相关技术博客文章