V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
smartdoc647
V2EX  ›  程序员

smart-doc 3.0.7 发布,支持生成 gRPC 协议接口文档

  •  
  •   smartdoc647 · 94 天前 · 701 次点击
    这是一个创建于 94 天前的主题,其中的信息可能已经有所发展或是发生改变。

    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/TongchengOpenSource/smart-doc

    重要更新内容

    • 添加 gRPC 接口文档生成支持
    • 完善 Java WebSocket 文档类型和 Message 请求的支持
    • 添加对 @JsonView 的支持

    社区贡献

    smart-doc 作为同程旅行大力支持的开源项目,对于社区贡献的 committer ,我们将提供书籍、文化衫等礼品作为奖励,非常欢迎社区用户参与共建。后续社区也会逐步增加其他语言的支持。

    未来计划

    新增对其它开发语言的支持(欢迎开发者加入参与社区共建)

    5 条回复    2024-08-22 08:37:26 +08:00
    securityCoding
        1
    securityCoding  
       94 天前
    跟 pb 比有啥优势么
    zhout
        2
    zhout  
       94 天前
    不支持分组,这点不太好,只能分模块导出,最终选了 swagger ,主要给前端看
    smartdoc647
        3
    smartdoc647  
    OP
       94 天前
    @zhout 同个模块下 controller 级别可以分组的,这个可以看官方文档有分组配置,当然不同用户可能对 API 的分组需求有些不同,很多场景用户不提 issue 我们可能没法覆盖到。我们和 swagger 有很多区别,我们目标给研发链提供更多的支持,所以支持多种接口协议的文档生成,性能测试脚本的生成。随之时间沉淀 smart-doc 在国内知名大厂用户反而更多了。
    smartdoc647
        4
    smartdoc647  
    OP
       94 天前
    @securityCoding gRPC 也是使用 pb 格式定义的
    zhout
        5
    zhout  
       91 天前
    @smartdoc647 希望能贴个链接,我看得官方文档的分组,只是支持按模块导出,不会聚合
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2941 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 30ms · UTC 14:27 · PVG 22:27 · LAX 06:27 · JFK 09:27
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.