V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  smartdoc647  ›  全部回复第 2 页 / 共 3 页
回复总数  43
1  2  3  
2023-07-14 13:58:23 +08:00
回复了 wtfedc 创建的主题 Kubernetes 半吊子如何操作 k8s 升级
k8s 升级没那么简单,搞不好饭碗不饱,只跑业务的容器还好,大数据上云的升级代价很高,我们 2000 多台机器的大数据 k8s 集群,升级前后花了几个月
2023-06-26 09:46:33 +08:00
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@jamel grpc 不支持,但是欢迎参与共建
2023-06-12 23:16:29 +08:00
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@tudou527 你们这个思路也可以,非常棒,主要是可以不改项目。这也是我之前想改造的方式。你们其实可以做些宣传,把 case 补起来。小公司的代码 case 是比较多的,大厂规范度相对高点。不过这类工具未来其实是可以用大模型训练去取代的,生成 api 这个完全可以训练出来。
2023-06-12 16:54:02 +08:00
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@iminto 可以分享下解决方案,如果 javadoc 完整解决 rest 业务接口的文档其实挺好的,但是我的了解是类嵌套这种肯定 javadoc 不行,工具的目的还是在于让程序员把事情做好的同时,少写点东西,所以 smart-doc 就是能自动解析的都给自动解析,
2023-06-12 14:10:37 +08:00
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@Masoud2023 真没几个人愿意手写文档,或者 openapi 这种结构化文档的,没必要把时候花费在这种对技术毫无增长的东西上,工具的目的是提升效率替代简单的工作。swagger 在中小公司还好,大厂基本用不起来,不要问我怎么知道的,毕竟我因为开源和阿里、蚂蚁、字节、华为都有接触。还有是不要有什么语言偏向性,大佬都是多语言并行的,像我这种菜狗也是 java 和 golang 主力开发并行,两个语言也都有开源贡献。我身边搞 java 的同事拿着 apache commiter 简直香的不行,走到哪里圈子里都会尊敬。
2023-05-09 16:19:43 +08:00
回复了 smartdoc647 创建的主题 程序员 smart-doc Java 零侵入 API 文档生成 2.6.8 发布
@iblessyou 扫描代码注释和范型解析 smart-doc 是目前所有相关 Java api 文档工具的鼻祖。尤其是范型拆解 smart-doc 问世之前行业内没人干过。japidocs 没啥可关注的了,无论是社区还是维护情况比 smart-doc 差太多了。
云原生大公司才有比较多的开发需求,例如大数据组件上云这块我们的 operator 全是自己开发的。但是需要对大数据组件的部署比较了解。每个公司方式也不太一样,纯业务的化云原生开发不太多,k8s 开源生态的基本可以 hold 住了
2023-03-29 11:40:45 +08:00
回复了 idlewater 创建的主题 程序员 同样类型的项目,个人开源能不能干过大厂开源?
个人开源需要有比较独特的东西才可能成功。我的 smart-doc 就是个人项目,目前来看在国内的使用情况还可以。也有大厂参照思路内部造轮子的,但是他们都没开源。主要是做的造,社区都知道最初的设计思路从哪里来的,可能也是大厂参考后不开源的原因
2023-02-28 15:02:23 +08:00
回复了 smartdoc647 创建的主题 程序员 smart-doc Java 零侵入 API 文档生成 2.6.5 发布
@lyxeno thank you
小公司没有严格的安全检查,大公司早就被安全部门找到你了,大厂一般点的情况先警告,严重的直接全公司通报,然后开除,领导也受会牵连。产品的核心其实好的交互设计,代码其实不重要,带走没什么意义,知道交互设计找个好的程序员就可以复制出好产品了。
2023-01-16 09:39:25 +08:00
回复了 xiaobai1213 创建的主题 程序员 Gradle 还是 Maven?
gradle 的问题主要是版本兼容性不行,对于业务项目搞都后面就项目多了就没人想动了,升级改配置麻烦,我做构建平台的就要给业务提供几个版本的 gradle 环境,maven 我只提供一个给业务目前都没发现问题。我开发 gradle 插件也是也有类似问题,兼容性不行,大版本升级就重新适配,不知道 gradle 7 以后的版本升级能不能兼容性好点
2021-08-19 14:27:04 +08:00
回复了 smartdoc647 创建的主题 分享创造 smart-doc Java 零注解侵入 API 文档工具 2.2.4 发布
@v2orz 有问题可以提 issue 的,附带导致错误的用例就可以,毕竟要面向很多写法。都是不断迭代修复
2021-08-19 13:49:04 +08:00
回复了 smartdoc647 创建的主题 分享创造 smart-doc Java 零注解侵入 API 文档工具 2.2.4 发布
@v2orz 自定义注解肯定不属于我的支持的范畴,注解属性就很宽泛,都是有一定框架使用范围的。开源一般只做一些标准框架支持
2021-07-22 23:09:17 +08:00
回复了 asanelder 创建的主题 程序员 API 文档大家是怎么生成的?
smart-doc+torna,目前开源产品中国内最成熟的,科大讯飞和顺丰这些公司都在用,不是吹出来的。
2021-07-22 22:51:09 +08:00
回复了 wetist 创建的主题 问与答 YAPI 是停止维护了吗?
yapi 国内有替代品,国内基于 java 开源的 torna 基本已经覆盖了 yapi 的功能,java 开发的同学配上 smart-doc 基本都不用自己写文档。https://gitee.com/durcframework/torna
2021-07-22 22:43:59 +08:00
回复了 Rogeryxx 创建的主题 Java 有没有觉的 swagger2 注解难用的,用注释生成文档不好么?
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 都有详细介绍。
1  2  3  
关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1978 人在线   最高记录 6679   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 27ms · UTC 00:25 · PVG 08:25 · LAX 16:25 · JFK 19:25
Developed with CodeLauncher
♥ Do have faith in what you're doing.