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

smart-doc 1.8.2 发布 Java 零侵入 API 文档生成工具

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

    smart-doc 是一个 java restful api 文档生成工具,smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上 java 的标准注释,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档和 Postman collection 一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc 给你一个不错的选择!喜欢 smart-doc 的用户也不要忘记给项目 star,你们的支持是 smart-doc 持续推进的动力。smart-doc 目前已经收录到开源中国。

    功能特性

    • 零注解、零学习成本、只需要写标准 java 注释。
    • 基于源代码接口定义自动推导,强大的返回结构推导。
    • 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
    • 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
    • 支持 JavaBean 上的 JSR303 参数校验规范,支持分组验证。
    • 对 json 请求参数的接口能够自动生成模拟 json 参数。
    • 对一些常用字段定义能够生成有效的模拟值。
    • 支持生成 json 返回值示例。
    • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
    • 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman collection。
    • 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。
    • 开放文档数据,可自由实现接入文档管理系统。
    • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
    • 集成 smart-doc-maven-plugin 插件实现第三方依赖库源码自动加载。

    项目仓库

    smart-doc 的码云仓库链接

    github 仓库地址链接

    更新内容

    1. 修改 gitee #I19IYW。
    2. 修改文档模板中的 title 设置错误。
    3. 修改 gitee #I191EO
    4. 支持 @Validated 分组

    升级建议

    本次主要修改了一些 bug 和增加对分组的支持。欢迎升级,推荐直接使用 smart-doc-maven-plugin 插件。

    DEMO

    使用 demo 轻松玩转接口文档生成

    相关文档

    smart-doc 文档 wiki

    smart-doc 的部分用户

    排名不分先后

    • 科大讯飞
    • 小米
    • 一加
    2 条回复    2020-03-16 19:59:31 +08:00
    leaybc
        1
    leaybc  
       2020-03-16 18:19:47 +08:00
    不错,看到我司有部门在用了。回头可以在项目中引进一下。
    hantsy
        2
    hantsy  
       2020-03-16 19:59:31 +08:00
    这个不叫 0 入侵吧。

    如果是喜欢编程式的生成文档的话,Spring 的 restdocs 不是更好的选择,所有 API 文档基于真正的测试代码,第一点可以证明文档是可靠性,还可以从测试中取样。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2749 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 12:48 · PVG 20:48 · LAX 05:48 · JFK 08:48
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.