smart-doc 1.7.5 发布，Java 零注解文档生成工具

内容简介：smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照j...

smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释的写，smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档。如果你已经厌倦了swagger等文档 工具 的无数注解和强侵入污染，那请拥抱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。
• 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
• 开放文档数据，可自由实现接入文档管理系统。

• 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。
• 支持导出错误码和定义在代码中的各种枚举字典到接口文档。

Smart-doc vs Swagger

•  smart-doc不是对Swagger造轮子，这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
•  smart-doc比swagger集成更简单，可以自由生成多种格式的api文档。
•  smart-doc完全不需要在侵入到业务代码中写任何注解，复杂嵌套对象自动推导出定义字段结构。
• smart-doc代码量很少，如果不能满足你的需求完全可以自己修改源码。

更新内容

•  优化文档中错误列表的标题，可根据语言环境变化显示中文或因为。
•  解决项目外jar中内部类生成文档错误的bug。
•  支持环形依赖分析。
•  修改使用SpringMvc或者SpringBoot上传时接口的Content-Type显示错误。
•  支持设置项目作为markdown的一级标题。
• 修改方法注释相同引起的html链接跳转错误。
• 添加生成AllInOne的覆盖配置项，默认自动加版本号不覆盖。
• 新增枚举字典导出到文档的功能。

升级建议

这次是根据用户提交的issues添加了一些功能和做了大量细节优化，为了更好的体验，无论是新老用户请升级到最新版本（最近国外仓库更新有点慢，如果不能下载的稍安勿躁）。

DEMO

使用demo轻松玩转接口文档生成

相关文档

关于java web restful api文档的重新探索

smart-doc功能使用介绍

项目官方wiki

用户评价

部分使用者对smart-doc的评价

1. 最强大的doc组件，强制要求了规范，也不会污染代码，欣喜之情溢于言表!
2. smartdoc从注释入手，即规范强化了文档的编写又能提供源码文档之外的api功能，真的对得起smart的称谓。

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持 码农网

查看所有标签

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。