V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
smartdoc647
V2EX  ›  程序员

smart-doc 3.0.9 发布, Java 零注解 API 文档生成工具

  •  
  •   smartdoc647 · 27 天前 · 824 次点击

    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

    重要更新内容

    • 修复了解析 @JsonProperty@JSONField 注解中常量错误的问题。
    • 修复了在没有方法时生成 Postman API 文档的 NPE 问题。
    • 修正了使用 @JsonValue 注解的枚举的示例值生成问题。

    未来计划

    新增对其它开发语言的支持, 欢迎对 golang 和 rust 语言感兴趣的同学加入社区,后续一起构建对 golang 和 rust 的支持

    目前尚无回复
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1108 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 19ms · UTC 18:01 · PVG 02:01 · LAX 10:01 · JFK 13:01
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.