Skip to content

使用指南总览

forge-swagger 把 Springdoc OpenAPI 3 与 Knife4j 增强 UI 集成进来,并自动把每个接口的响应在文档层包装为 Result,让接口文档与运行时返回结构保持一致。

适用场景

  • 想要零样板的 OpenAPI 3 集成(开箱即用的 Swagger UI 与 Knife4j)
  • 已经在用 forge-core 的统一响应包装,希望文档里看到 Result«User» 这种包装后的 schema
  • 不想让 @RawResponse 的接口在文档里被错误地包装

章节导航

文档你能学到
快速开始引入依赖、访问 Swagger UI 与 Knife4j、看到 Result 包裹
配置说明application.yml 中可配置的 springdoc / knife4j 项、覆盖默认 OpenAPI Bean
常见场景跳过包装、生产环境关闭文档、自定义 contact / license

想了解机制

跳转 设计文档