Yoo趣儿

Yoo趣儿 › 编程语言 › Java › smart-doc Java 零侵入 API 文档生成 2.6.9 发布 ...

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

查看 59|回复 1
作者：smartdoc647   
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 接口文档生成。

    更新内容
    [ol]
  • 修复 qdox 不允许将字段名命名为 permits 关键字的 bug ，#498
  • dubbo 接口继承父类时，父类中接口未解析问题修复。#493
  • 优化插件对许多无关依赖的过滤，提升插件开箱即用的能力。
  • 支持禁用随机 mock 值生成，#497
    [/ol]
    发展情况
    smart-doc 开源维护接近五年，目前很多功能已经非常稳定，国内有很多的用户。码云 star 超过 3k 。smart-doc 官方布道的企业级文档管理系统 torna 的 docker 镜像下载量超过 10k 。国内已有数家知名司在使用 smart-doc ，如：科大讯飞、小米、一加、顺丰、马蜂窝、同程旅行等。smart-doc+torna 的整套 API 管理体系已经被很多公司落地使用。

    smart-doc, 生成, 文档, API

    • 相关帖子

    GuryYu   
    正在使用，生成文档非常方便
    返回列表
    您需要登录后才可以回帖 登录 | 立即注册

    AD1

    热门主题

    热门板块

    问与答分享发现分享创造奇思妙想分享邀请码商业推广优惠信息PythonPHPJavaJavaScriptNode.jsGo语言C++HTML

    公告

    标签|小黑屋|Yoo趣儿

    GMT+8, 2024-11-22 15:58 , Processed in 0.009650 second(s), 6 queries , Gzip On, MemCached On.

    Powered by Discuz! X3.2

    The happiest thing in the world is to strive for an ideal.

    返回顶部