V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  smartdoc647  ›  全部回复第 1 页 / 共 2 页
回复总数  36
1  2  
22 天前
回复了 loyth06 创建的主题 程序员 咨询: Go 开发 api 管理工具
go 语言做 web 开发,api 管理工具不是最重要的,生成 API 文档的过程很烦,go swagger 页要求程序员写一堆的注释。
我自己是 java 文档生成工具 smart-doc 的作者。目前也只一个主力 go 语言的应用开发者。管理工具其实已经很多了,针对 go 语言文档生成端非常的弱
@xgfan 你可以理解为就是一种宣传和社区运营,让更多人来一起参与贡献,至于礼物多少价值真正参与开源的人并不在乎这些,所以也并不怕被喷。我们也是真正的做开源,项目在国内用户也很多,我们问心无愧。
@dianso 不能用物品价值去衡量开源社区奖品,奖品对于贡献者是鼓励和纪念意义。大多数开源社区本质是没有任何商业盈利的,也没有谁规定必须任何社区要给 Committer 发奖品,社区大多数的奖品也是文化衫或者是技术相关的图书。
我们非常尊重行业每一个真正的开源技术社区和无数的开源贡献者。
@musi 这个只是个宣传,目前也没有专业的社区运营人员,没什么尬的,至少我们也是国内极少数真实的给了贡献者一些小奖励的开源社区。也是为了鼓励更多人参与开源社区的贡献。
@Philippa swagger 对群主框架就没啥用的,go 框架也能用 swagger 搞,但是我们发现这东西无脑让写一堆非标注释。理想的情况就是既不去影响用户的代码,又不能要求用户写一堆非标注释增加开发的负担。smart-doc 在国内在 java 领域非常受欢迎也是这个原因。我们的贡献者甚至都有小米、快手这些公司的。
无注解框架的有一个痛点就是搞接口文档比较难,其实很多开发都不想手写文档,像我们开源的 smart-doc 对 spring 这种注解路由的框架,工程师已经只需要写几行简单的 javadoc 注释了。生成的文档质量也远超手写的。我同时也是一个 golang 开发者,我们发现 go 的框架基本也是声明式路由,搞文档就很头痛
119 天前
回复了 smartdoc647 创建的主题 Go 编程语言 smart-doc 开源社区招募 golang 开发者
@imianba2zz 你这个是很好思路,但是这个很难推广落地。减少了注释,但是比如像字段的注释,验证规则这些没没法通过网络数据来抓取,文档不完善让开发再去改非常难。go 框架主要是入口层面没有没法直接知道返回和入参,导致注释很多。如果你看现在 smart-doc 在 java 那块支持就很少,注释就只是描述下字段,简单写个方法用户说明。另外是像 smart-doc 在一些公司目前在 java 上是在 CI 的构建层面去工作的。压测其实并不需要自己去开发压测工具,我们的目的是生成工具需要的标准文件,然后倒入进去测试,就是支持现有的开源生态。
119 天前
回复了 smartdoc647 创建的主题 Go 编程语言 smart-doc 开源社区招募 golang 开发者
120 天前
回复了 smartdoc647 创建的主题 Go 编程语言 smart-doc 开源社区招募 golang 开发者
@jaycelhz 没特殊要求哈,愿意的就可以参与
120 天前
回复了 smartdoc647 创建的主题 Go 编程语言 smart-doc 开源社区招募 golang 开发者
@0xGnaixEuy 技术没有要求,社区更多的是愿意参与贡献,新手也是可以的,慢慢搞
121 天前
回复了 6581 创建的主题 Go 编程语言 go json.Unmarshal 深拷贝性能太差怎么办?
go 官方这个原生 json 库性能确实不太高。普通业务没什么问题,高并发场景官方库性能真不行,比如做日志实时消费不停处理 json 这种,我们压测性能确实一般,不要迷性官方库一定就性能好。
@Uplay 下载 smart-doc 代码和插件,然后上传到内网 maven 仓库就可以了
236 天前
回复了 guonaihong 创建的主题 Go 编程语言 高性能 websocket 库 quickws 发布
你们这个 antlab 名字搞得可以,搞开源看着也比较正经
285 天前
回复了 wtfedc 创建的主题 Kubernetes 半吊子如何操作 k8s 升级
k8s 升级没那么简单,搞不好饭碗不饱,只跑业务的容器还好,大数据上云的升级代价很高,我们 2000 多台机器的大数据 k8s 集群,升级前后花了几个月
304 天前
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@jamel grpc 不支持,但是欢迎参与共建
317 天前
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@tudou527 你们这个思路也可以,非常棒,主要是可以不改项目。这也是我之前想改造的方式。你们其实可以做些宣传,把 case 补起来。小公司的代码 case 是比较多的,大厂规范度相对高点。不过这类工具未来其实是可以用大模型训练去取代的,生成 api 这个完全可以训练出来。
317 天前
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@iminto 可以分享下解决方案,如果 javadoc 完整解决 rest 业务接口的文档其实挺好的,但是我的了解是类嵌套这种肯定 javadoc 不行,工具的目的还是在于让程序员把事情做好的同时,少写点东西,所以 smart-doc 就是能自动解析的都给自动解析,
317 天前
回复了 smartdoc647 创建的主题 Java smart-doc Java 零侵入 API 文档生成 2.7.0 发布
@Masoud2023 真没几个人愿意手写文档,或者 openapi 这种结构化文档的,没必要把时候花费在这种对技术毫无增长的东西上,工具的目的是提升效率替代简单的工作。swagger 在中小公司还好,大厂基本用不起来,不要问我怎么知道的,毕竟我因为开源和阿里、蚂蚁、字节、华为都有接触。还有是不要有什么语言偏向性,大佬都是多语言并行的,像我这种菜狗也是 java 和 golang 主力开发并行,两个语言也都有开源贡献。我身边搞 java 的同事拿着 apache commiter 简直香的不行,走到哪里圈子里都会尊敬。
@iblessyou 扫描代码注释和范型解析 smart-doc 是目前所有相关 Java api 文档工具的鼻祖。尤其是范型拆解 smart-doc 问世之前行业内没人干过。japidocs 没啥可关注的了,无论是社区还是维护情况比 smart-doc 差太多了。
云原生大公司才有比较多的开发需求,例如大数据组件上云这块我们的 operator 全是自己开发的。但是需要对大数据组件的部署比较了解。每个公司方式也不太一样,纯业务的化云原生开发不太多,k8s 开源生态的基本可以 hold 住了
1  2  
关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   3666 人在线   最高记录 6543   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 24ms · UTC 05:02 · PVG 13:02 · LAX 22:02 · JFK 01:02
Developed with CodeLauncher
♥ Do have faith in what you're doing.