V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
smartdoc647
V2EX  ›  分享创造

smart-doc 2.3.7 发布,支持 JAX-RS 规范实现框架的 API 文档生成

  •  
  •   smartdoc647 · 2022-01-18 10:56:53 +08:00 · 1488 次点击
    这是一个创建于 800 天前的主题,其中的信息可能已经有所发展或是发生改变。

    smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档,不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件,然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档,生成后可以直接导入相关工具做测试。

    查看快速开始 了解详情

    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 接口文档生成。

    Best Practice

    smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用 smart-doc 无侵入完成 Java 源代码分析和提取注释生成 API 文档,自动将文档推送到 Torna 企业级接口文档管理平台。

    smart-doc+torna

    发展情况

    smart-doc 依赖开源维护超过三年的时间,目前很多功能已经非常稳定,国内有很多的用户。码云 star 达到 2.5k(我们从来不屑于刷 star)。smart-doc 官方布道的企业级文档管理系统 torna 的 docker 镜像下载量超过 10k 。国内已有数家知名司在使用 smart-doc ,如:科大讯飞、小米、一加、顺丰、马蜂窝、同程旅行等。目前使用 smart-doc 的国内企业大中小企业有数百家。也有极少数的国外用户。

    1 条回复    2022-01-18 14:05:11 +08:00
    drupal
        1
    drupal  
       2022-01-18 14:05:11 +08:00
    加油,如果有整套的安装配置视频则更佳
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1324 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 23:32 · PVG 07:32 · LAX 16:32 · JFK 19:32
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.