如何通过注释非侵入式生成SpringBoot接口的Smart-Doc文档？

本文共计4950个文字，预计阅读时间需要20分钟。

Swagger系列可以帮助快速生成API文档，但生成文档需要在接口上添加注释等，这表明这是一种侵入式方式；那么有没有非侵入式方式呢？比如通过注释生成文档？本文主要介绍这种非侵入式方式。

通过Swagger系列可以快速生成API文档，但是这种API文档生成是需要在接口上添加注解等，这表明这是一种侵入式方式； 那么有没有非侵入式方式呢, 比如通过注释生成文档？ 本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标，而是要了解非侵入方式能做到什么程度和技术思路。 @pdai

• SpringBoot接口 - 如何生成接口文档之非侵入方式（通过注释生成）Smart-Doc？
  • 准备知识点
    • 为什么会产生Smart-Doc这类工具？
    • 什么是Smart-Doc？有哪些特性？
  • 实现案例
    • 配置
    • 运行测试
    • 生成更多类型的文档
  • 进一步理解
    • 注释信息是有限的，smart-doc如何从注释拓展文档内容呢？
    • Maven多模块中使用插件有没有比较好的实践？
    • 如果生成文档时遇到问题，该如何调试？
  • 示例源码
  • 更多内容

需要了解Swagger侵入性和依赖性， 以及Smart-Doc这类工具如何解决这些问题, 部分内容来自官方网站。