📚 接口文档
- 专业接口对接机制，统一采用 RESTful APIs 接口方式，集成 SpringDoc 整合 Swagger 在线接口文档。
接口文档技术方案选型
- 基于
javadoc无注解零入侵生成规范的OpenAPI结构体。
javadoc
javadoc 从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过 Javadoc 就可以同时形成程序的开发文档了。
javadoc 命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
OpenAPI
解答：OpenAPI 是一个用于描述、定义和共享 RESTful API文档的规范。最新规范是 OpenAPI 3.0。
Swagger
Swagger 是一个用于设计和测试 RESTful APIs 的工具。
它提供了API 描述、请求和响应示例、API 测试和文档生成等丰富的功能。最新版本是 Swagger3，支持 OpenAPI3.0 规范。
SpringFox
SpringFox 是 Spring 社区维护的一个项目（非官方），帮助使用者将 Swagger 2 集成到 Spring 中。
SpringDoc
SpringDoc 也是 Spring 社区维护的一个项目（非官方），帮助使用者将 Swagger 3 集成到 Spring 中。
SpringDoc 支持 Swagger 页面 Oauth2 登录，相较于 SpringFox 而言，它的支撑时间更长，无疑是更好的选择。
但是在国内发展较慢，网上一找资料，出来的基本上是 Swagger2的内容。
OpenAPI、 SpringFox、SpringDoc 和 Swagger 之间的关系
OpenAPI 定义了一种标准的格式来表示 API 文档，而 Swagger 是一个实现 OpenAPI 规范的工具。 在 SpringBoot 3.0 之前，用的都是 SpringFox 来集成 Swagger 管理 API 接口文档。 目前 SpringFox 已经停止更新了，SpringBoot 3.0 之后，Spring 官方推荐 SpringDoc 来整合 Swagger。
接口文档工具使用
由于框架采用 OpenAPI 行业规范 故市面上大部分的框架均支持 可自行选择。
SpringDoc
- 一个基于OpenAPI 3.0规范的自动API文档生成工具
SpringDoc 是一个基于 OpenAPI 3.0 规范的自动API文档生成工具，专为 Spring Boot 项目设计。
Knife4j
- 一个集 Swagger2 和 OpenAPI3 为一体的增强解决方案
Knife4j 是一个集 Swagger2 和 OpenAPI3 为一体的增强解决方案，帮助开发者快速聚合使用OpenAPI规范。
Apifox
- API 设计、开发、测试一体化协作平台
Apifox = Postman + Swagger + Mock + JMeter
Apipost
- AI驱动的下一代API开发管理工具
Apipost是集API设计、API调试、API文档、自动化测试为一体的API研发协同平台,支持 gRPC、HTTP、WebSocket、Socket.IO、SocketJS 类型接口调试,支持私有化部署。
Postman
- API开发、测试和文档管理工具
Postman 为开发者提供 API开发、测试和文档管理工具，帮助简化API工作流程。无论是测试还是文档管理，Postman 都为开发者提供全面的解决方案。
Torna
- 面向企业级的接口文档管理平台
Torna 是一款面向企业级的接口文档管理平台，旨在优化接口文档的集中管理、协作维护及高效调试。