这是一个创建于 1360 天前的主题，其中的信息可能已经有所发展或是发生改变。
先来介绍分别介绍下 smart-doc 和 Torna
smart-doc
smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具，smart-doc 在业内率先提出基于 JAVA 泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照 java-doc 标准编写注释，smart-doc 就能帮你生成一个简易明了的 Markdown 、Postman Collection2.0+、OpenAPI 3.0+的文档。除此之外 smart-doc 还支持生成漂亮简洁可调试的 html5 页面文档。
smart-doc 目前的国内知名的企业科大讯飞、小米、中国移动中都有一些研发团队在用，中小型公司就比较多了，码云的 star 数 1.2K(无任何水分的 star)。smart-doc 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 奖。
Torna
2021 年 3 月在码云平台新开源的企业级接口文档管理平台。目标是让文档管理变得更加方便、快捷。Torna 采用团队协作的方式管理和维护项目 API 文档，将不同形式的文档纳入进来，形成一个统一的维护方式。
Smart-doc+Torna 全接口流程自动化
smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用 smart-doc 无侵入完成 Java 源代码分析和提取注释生成 API 文档，自动将文档推送到 Torna 企业级接口文档管理平台。
[smart-doc+Torna 文档自动化]( https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc 与 torna 对接?sort_id=3695028)
这是行业内目前唯一实现从注释提取生成文档到文档管理平台完全开源的自动化方案
目前尚无回复
Select Language