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

smart-doc Java 零侵入 API 文档生成 2.6.8 发布

  •  1
     
  •   smartdoc647 · 2023-05-04 09:47:05 +08:00 · 1045 次点击
    这是一个创建于 560 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    Features

    • 零注解、零学习成本、只需要写标准 JAVA 注释。
    • 基于源代码接口定义自动推导,强大的返回结构推导。
    • 支持 Spring MVC 、Spring Boot 、Spring Boot Web Flux(controller 书写方式)、Feign 。
    • 支持 JAX-RS 实现的 WEB 框架,例如 Quarkus 。
    • 支持 Callable 、Future 、CompletableFuture 等异步接口返回的推导。
    • 支持 JavaBean 上的 JSR303 参数校验规范,包括分组验证。
    • 对 JSON 请求参数的接口能够自动生成模拟 JSON 参数。
    • 对一些常用字段定义能够生成有效的模拟值。
    • 支持生成 JSON 返回值示例。
    • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
    • 支持生成多种格式文档:Markdown 、HTML5 、Asciidoctor 、Postman Collection 、OpenAPI 3.0 。Up- 开放文档数据,可自由实现接入文档管理系统。
    • 支持导出错误码和定义在代码中的各种字典码到接口文档。
    • 支持 Maven 、Gradle 插件式轻松集成。
    • 支持 Apache Dubbo RPC 接口文档生成。

    更新内容

    1. 支持扩展对 DocJavaMethod 进行数据自定义处理,#488
    2. 修复 mock 值中使用 cron 表达式后转义值问题。#487
    3. 支持 gson 别名解析。 [#485]( https://github.com/smart-doc-group/smart-doc/pull/485
    4. 修复无法获取多层继承的父类接口 bug 。#480
    5. 支持接口中使用多个 @RequestBody 。 #pr475
    6. 升级 jquery ,#pr474
    7. 修复 file 字段 required 设置,#pr470
    8. 修复多 path 错误,#466

    发展情况

    smart-doc 开源维护接近五年,目前很多功能已经非常稳定,国内有很多的用户。码云 star 超过 3k 。smart-doc 官方布道的企业级文档管理系统 torna 的 docker 镜像下载量超过 10k 。国内已有数家知名司在使用 smart-doc ,如:科大讯飞、小米、一加、顺丰、马蜂窝、同程旅行等。smart-doc+torna 的整套 API 管理体系已经被很多公司落地使用。

    3 条回复    2023-05-09 19:44:42 +08:00
    iblessyou
        1
    iblessyou  
       2023-05-05 09:55:47 +08:00
    和那个 japidocs 是什么关系呢 看着好像
    smartdoc647
        2
    smartdoc647  
    OP
       2023-05-09 16:19:43 +08:00
    @iblessyou 扫描代码注释和范型解析 smart-doc 是目前所有相关 Java api 文档工具的鼻祖。尤其是范型拆解 smart-doc 问世之前行业内没人干过。japidocs 没啥可关注的了,无论是社区还是维护情况比 smart-doc 差太多了。
    iblessyou
        3
    iblessyou  
       2023-05-09 19:44:41 +08:00
    @smartdoc647 哦 有空试试。
    看到网页感觉很眼熟,再看了内容,感觉也很眼熟,
    就在书签翻了下,发现自己收藏过,但不是同一个东西。
    也再看了那个,确实很久没维护了,看着俩官网都长得差不多的东西,以为是同一个人弄的呢
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   4542 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 31ms · UTC 04:05 · PVG 12:05 · LAX 20:05 · JFK 23:05
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.