smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档,不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件,然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档,生成后可以直接导入相关工具做测试。
查看快速开始 了解详情
https://github.com/smart-doc-group/smart-doc
smart-doc 开源维护接近五年,目前很多功能已经非常稳定,国内有很多的用户。码云 star 超过 3k 。smart-doc 官方布道的企业级文档管理系统 torna 的 docker 镜像下载量超过 10k 。国内已有数家知名司在使用 smart-doc ,如:科大讯飞、小米、一加、顺丰、马蜂窝、同程旅行等。smart-doc+torna 的整套 API 管理体系已经被很多公司落地使用。
1
iblessyou 2023-05-05 09:55:47 +08:00
和那个 japidocs 是什么关系呢 看着好像
|
2
smartdoc647 OP @iblessyou 扫描代码注释和范型解析 smart-doc 是目前所有相关 Java api 文档工具的鼻祖。尤其是范型拆解 smart-doc 问世之前行业内没人干过。japidocs 没啥可关注的了,无论是社区还是维护情况比 smart-doc 差太多了。
|
3
iblessyou 2023-05-09 19:44:41 +08:00
@smartdoc647 哦 有空试试。
看到网页感觉很眼熟,再看了内容,感觉也很眼熟, 就在书签翻了下,发现自己收藏过,但不是同一个东西。 也再看了那个,确实很久没维护了,看着俩官网都长得差不多的东西,以为是同一个人弄的呢 |