内容简介:smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDo...
smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上 java 的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他 工具 强侵入的注解污染,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 collection。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据,可自由实现接入文档管理系统。
- 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解。
更新内容
1. 增加从接口方法getter或者setter方法中读取注释。
2. 修改smart-doc默认编码为utf-8,解决生成文档乱码问题。
3. 增强对代码中@author tag的支持,当方法没有@author tag支持多作者。
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin,推荐使用最新版本的插件。
升级建议
最近的版本重写了大多数功能,近期有多数用户反馈生成文档存在乱码,因此我们做了紧急版本发布解决乱码功能
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
相关文档
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:- 无需额外注解的 Spring Boot API 文档生成工具
- Java 注解预处理 Annotation Processing & 代码生成
- JApiDocs 1.3 发布,无需额外注解的 SpringBoot API 文档生成工具
- smart-doc 1.0 发布,Java 零注解文档生成工具
- java 零注解文档生成工具 smart-doc 1.1 发布
- Java 零注解文档生成工具 smart-doc 1.2 发布
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
Web信息架构(第3版)
[美] Peter Morville、Louis Rosenfeld / 陈建勋 / 电子工业出版社 / 2013-10 / 99.00元
本书内容涵盖了信息架构基本原理和实践应用的方方面面。全书共7个部分,包括信息架构概述、信息架构的基本原理、信息架构的开发流程和方法论、信息架构实践、信息架构与组织、两个案例研究,以及参考资料清单。 本书兼具较高的理论价值和实用价值,曾被Web设计领域多本书籍重点推荐,是信息架构领域公认的经典书籍,不论新手还是专家都能各取所需。本书可供Web设计与开发者、Web架构师、网站管理者及信息管理相关......一起来看看 《Web信息架构(第3版)》 这本书的介绍吧!