这是一个创建于 855 天前的主题，其中的信息可能已经有所发展或是发生改变。
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 接口文档生成。
更新内容
使用推荐
smart-doc 当前已经是国内在 java 技术栈上除 swagger 外被使用最多的 api 文档工具，码云平台 star 2.9k+，github 平台 star 750+。开源已经走过四年，目前已经比较成熟，欢迎使用和提 issue
 |
1
yao00jun 2022-08-22 12:53:35 +08:00
支持，挺好用的
|
 |
2
lazyfighter 2022-08-22 14:44:40 +08:00
提个建议， 我看你们对接了个自己的文档管理平台， 对接上飞书、语雀文档每次推送到这上面， 覆盖的人群会更多一些
|
Select Language