推荐一个 Java 零注解零侵入 API 文档生成工具-问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

推荐一个 Java 零注解零侵入 API 文档生成工具

2019-12-09 10:57:04 3045 5

在过去,java web 开发者生产文档通常需要引入 swagger,然后写一堆注解侵入到业务代码中,这让很多开发者很讨厌。2018 年一款基于源码分析的零注解零侵入文档生成工具 smart-doc 正式在开源中国开源。经过一年多的时间 smart-doc 已经被中国上百家中小企业集成到公司的项目生成 api 接口文档。甚至有像科大讯飞、一加这样的知名企业用户。smart-doc 不侵入,并且几乎没有使用学习成本。在一年多的版本迭代中也完善了使用文档。目前主要支持 SpringBoot 技术栈开发的文档生成。想使用的 java 开发这可以查看 smart-doc 项目: github: https://github.com/shalousun/smart-doc.git

gitee: https://gitee.com/sunyurepository/smart-doc.git

取消 提交回答
全部回答(5)
  • 茶什i
    2019-12-12 10:04:02

    smart-doc 支持生成静态 html、markdown、adoc 甚至是 postman 上测试的接口 json 文件,生成的 html 页面干净整理开用和 Spring 官方文档一样的模板样式,markdown 我们有很多用户稍微修改下就能转成 pdf 作为和外部公司的对接文档。postman 的 json 文件可以一键导入。码云上的 wiki 都有详细介绍。

    0 0
  • 钉群小二
    2019-12-12 09:50:55

    看了一下是使用测试用例来生成的文档,但是 Spring 不是有一个 Spring Rest Doc 吗,可以直接和 mockMvc 的测试代码结合,更方便

    0 0
  • 小熊软糖bear
    2019-12-12 09:49:34
    0 0
  • 珍宝珠
    2019-12-12 09:47:19

    分享一下自己的半成品: https://github.com/chendy560/c2d

    0 0
  • 游客pklijor6gytpx
    2019-12-09 10:59:17

    swagger 虽然入侵,但更强大。java doc 不方便直接生成易读性的文档生成,smart-doc 利用约定好的注释格式,生成文档,很强。我更大的需求是可以自动生成 html 静态资源,或自动直接在公司环境生成 web 版本,甚至自动在 web 端进行 REST 接口的简单测试。

    0 0
添加回答
相关问答

1

回答

Java的覆写方法怎么注解?

2021-10-12 16:14:42 321浏览量 回答数 1

0

回答

请问java性能问题:如何优化向HashMap插入元素的速度?

2021-11-12 17:18:18 124浏览量 回答数 0

0

回答

请问java中使用BigDecimal计算操作性能最优的做法是什么?

2021-11-07 15:42:19 197浏览量 回答数 0

1

回答

java性能问题:有没有比较字符串是否相等的最快方法?

2021-11-06 16:21:40 150浏览量 回答数 1

0

回答

您好java性能问题:有没有比较字符串是否相等的最快方法?

2021-11-07 00:39:14 129浏览量 回答数 0

1

回答

java性能问题:如何优化向HashMap插入元素的速度?

2021-11-06 15:41:34 199浏览量 回答数 1

0

回答

请问java中常用的性能调优诊断工具都有哪些,请帮忙提供一下?

2021-11-06 22:35:44 74浏览量 回答数 0

1

回答

java中常用的性能调优诊断工具都有哪些,请帮忙提供一下?

2021-11-06 10:24:39 143浏览量 回答数 1

1

回答

java中使用BigDecimal计算操作性能最优的做法是什么?

2021-11-06 16:35:15 215浏览量 回答数 1

1

回答

java中DoubleBufferedQueue与ArrayBlockingQueue哪个性能更高?

2021-11-06 21:50:01 172浏览量 回答数 1
0
文章
2554
问答
问答排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载