smart-doc 1.8.0 发布 Java 零侵入 API 文档生成工具
smart-doc 是一个 java restful api 文档生成工具,smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上 java 的标准注释,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档和 Postman json 一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc 给你一个不错的选择!喜欢 smart-doc 的用户也不要忘记给项目 star,你们的支持是 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 json。
- 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
项目仓库
smart-doc 的码云仓库链接
github 仓库地址链接
更新内容
-
响应用户需求,对 spring 的表单参数绑定做了全面的支持,smart-doc 不再是仅仅支持 json 参数。
-
合并 fork 分支的 github book html5 模板,新增搜索和锚点。
-
新增自定义 @mock tag 用于指定生成文档时的默认字段值,@param 的参数注释增加 mock 值的解析功能(@param name 姓名|张三), 此项改进可以满足用户直接使用 smart-doc 生成交付给第三方公司的对接文档。
-
smart-doc-maven-plugin 插件增强对 maven 标准项目的支持(插件仍然存在一些问题,当前未找到解决办法)。
-
对生成的 postman json 数据做了全面的增强,无论是 json 还是表单参数,导出的 postman json 可以一键导入 postman 自动完成参数列表回填。
-
优化对实体类中枚举字段的支持。
-
增加对实体中静态常量常量字段的过滤。
升级建议
本次主要是对表单参数和 postman 数据导出做了增强。也修改了一起 bug 和部分源码做了重构,建议用户升级到最新。
DEMO
使用 demo 轻松玩转接口文档生成
相关文档
smart-doc 文档 wiki
smart-doc 的部分用户
排名不分先后
- 科大讯飞
- 小米
- 一加
- 北京远盟健康