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

smart-doc 1.84 最好用的 Java 文档生成工具新版本发布

  •  
  •   smartdoc647 · 2020-03-31 09:42:02 +08:00 · 1356 次点击
    这是一个创建于 1680 天前的主题,其中的信息可能已经有所发展或是发生改变。

    smart-doc 是一个 java restful api 文档生成工具,smart-doc 基于源码和源码注释分析生成文档,全程无侵入。并且易集成。官方已在码云仓库上维护了相关完善的文档供国内使用者参考。smart-doc 目前是 spring boot 技术栈上最好用的 java 文档生成工具。欢迎使用和提出相关改进建议。

    功能特性

    • 零注解、零学习成本、只需要写标准 java 注释。
    • 基于源代码接口定义自动推导,强大的返回结构推导。
    • 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
    • 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
    • 支持 JavaBean 上的 JSR303 参数校验规范,支持分组验证。
    • 对 json 请求参数的接口能够自动生成模拟 json 参数。
    • 对一些常用字段定义能够生成有效的模拟值。
    • 支持生成 json 返回值示例。
    • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
    • 支持生成多种格式文档:Markdown 、HTML5 、Asciidoctor 、Postman collection 。
    • 插件式快速集成。

    项目仓库

    smart-doc 的码云仓库链接

    github 仓库地址链接

    更新内容

    1. Controller 新增时候 @ignore tag,可适应该 tag 忽略不需要生成文档的 controllergit #24
    2. 参数中包含 HttpSession 时 smart-doc 卡主,gitee #I1CA9M
    3. 解决一些复杂分组场景 smart-doc 报错的问题gitee #I1CPSM
    4. 解决 smart-doc-maven-plugin 插件读取配置乱码问题。

    升级建议

    入口无变更,建议平滑升级。

    相关文档

    smart-doc 文档 wiki

    smart-doc 的部分用户

    • 科大讯飞
    • 小米
    • 一加
    1 条回复    2020-03-31 12:34:00 +08:00
    cheng6563
        1
    cheng6563  
       2020-03-31 12:34:00 +08:00 via Android
    广告法警告
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1694 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 19ms · UTC 16:43 · PVG 00:43 · LAX 08:43 · JFK 11:43
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.