Swagger API文档 | SpringDoc常用配置

文章结构概览

• 注入 API 参数及安全设置
  • 通过 @ControllerAdvice 实现 REST 接口异常处理机制
  • 如何关闭 api-docs 与 swagger-ui 功能？
  • 对 Swagger-UI 进行个性化配置
  • 确定需要生成文档的 Controller 类
  • 支持在 Spring-WebFlux/WebMvc.fn 中的函数式端点
  • 实现与 WildFly 的整合
  • 相关技术文章

🗯️ 上节内容回顾：在上一章节中，对 SpringDoc 的配置参数进行了说明。
👉 当前章节目标：阐述 SpringDoc 中常见的配置方式。

添加 API 信息和安全配置

通过在 Spring 管理的 Bean 上配置 @OpenAPIDefinition 与 @SecurityScheme 注解，能够完成对 API 文档的构建与描述。例如，可以定义诸如标题、版本、授权信息、安全策略、服务器地址、标签以及外部文档链接等参数。
例如：

    @Configuration
    @OpenAPIDefinition(info = @Info( = "My App", description = "description"))
    public c