smartdoc647 最近的时间轴更新
smartdoc647

smartdoc647

V2EX 第 445380 号会员,加入于 2019-10-09 14:08:01 +08:00
smartdoc647 最近回复了
@v2orz 有问题可以提 issue 的,附带导致错误的用例就可以,毕竟要面向很多写法。都是不断迭代修复
@v2orz 自定义注解肯定不属于我的支持的范畴,注解属性就很宽泛,都是有一定框架使用范围的。开源一般只做一些标准框架支持
301 天前
回复了 asanelder 创建的主题 程序员 API 文档大家是怎么生成的?
smart-doc+torna,目前开源产品中国内最成熟的,科大讯飞和顺丰这些公司都在用,不是吹出来的。
301 天前
回复了 wetist 创建的主题 问与答 YAPI 是停止维护了吗?
yapi 国内有替代品,国内基于 java 开源的 torna 基本已经覆盖了 yapi 的功能,java 开发的同学配上 smart-doc 基本都不用自己写文档。https://gitee.com/durcframework/torna
spring 技术栈 smart-doc+torna 才是王道
2020-12-22 12:40:40 +08:00
回复了 smartdoc647 创建的主题 程序员 请不要再使用 swagger 了,给你推荐这款工具
@chendy 重新搞东西都是很难的,需要耗费很多精力,smart-doc 开发的过程中也经历过很艰难的时候想放弃,但是后来因为得到很多开发者的喜爱和一些大公司的引入才有了维护下去的动力。关于是以代码先行还是设计先行,这和 smart-doc 这种工具本身不冲突,我们团队很多项目也是设计先行,但是根据设计写好代码后可以通过工具扫描代码生成接口文档,比如 openapi 的文档数据,然后可以把这种文档直接发送到集中化的文档管理系统中,这对于大型微服务文档集中化管理还是提供了很多遍历的。
2020-12-22 10:40:56 +08:00
回复了 smartdoc647 创建的主题 程序员 请不要再使用 swagger 了,给你推荐这款工具
@hantsy 首先非常欣赏你丰富的研发经验。第二种方式本身和这个工具不存在冲突,当然实际落地也很难。
smart-doc 开源的初衷也不是奔着造轮子去的,在使用 smart-doc 之前我也使用过你提到的这些工具,可能是我经验欠缺吧没有用好它们,反正就是对这些工具够不满意,然后重新开发了这个工具。后来在不断的开源迭代中,发现得到国内很多开发者的支持,在这个发展过程中,我们也一直关注国内外相关的工具、也非常重视像 OpenAPI 3.0 这样的行业标准。因此我们也做大量的支持和测试。
2019-12-06 09:49:50 +08:00
回复了 smartdoc647 创建的主题 程序员 推荐一个 Java 零注解零侵入 API 文档生成工具
注意看文档,一个单元测试仅仅用于启动 smart-doc 扫描代码,smart-doc 和 swagger、Spring Rest Doc 都不是一个原理,smart-doc 完全基于定义好的接口源码和注释分析生成文档。我一直的原则是,如果重复造轮子又不能比现有工具好没有意义。
2019-12-05 23:47:12 +08:00
回复了 smartdoc647 创建的主题 程序员 推荐一个 Java 零注解零侵入 API 文档生成工具
smart-doc 支持生成静态 html、markdown、adoc 甚至是 postman 上测试的接口 json 文件,生成的 html 页面干净整理开用和 Spring 官方文档一样的模板样式,markdown 我们有很多用户稍微修改下就能转成 pdf 作为和外部公司的对接文档。postman 的 json 文件可以一键导入。码云上的 wiki 都有详细介绍。
2019-12-05 23:30:33 +08:00
回复了 smartdoc647 创建的主题 程序员 推荐一个 Java 零注解零侵入 API 文档生成工具
smart-doc 是强制要求写注释的,上百家企业选择不是自己吹的,没有好的点就成烂尾项目了
关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2421 人在线   最高记录 5497   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 23ms · UTC 11:37 · PVG 19:37 · LAX 04:37 · JFK 07:37
Developed with CodeLauncher
♥ Do have faith in what you're doing.