同步操作将从 同程旅行/smart-doc 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
smart-doc[smɑːt dɒk]
是一款同时支持JAVA REST API
和JAVA WebSocket
和Apache Dubbo RPC
接口文档生成的工具,smart-doc
在业内率先提出基于JAVA
泛型定义推导的理念,
完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照Javadoc
标准编写注释, smart-doc
就能帮你生成一个简易明了的Markdown
、HTML5
、Postman
Collection2.0+
、OpenAPI 3.0+
的文档。
$\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$
无论你是很有经验的大佬、还是刚入行的萌新。遇到使用疑惑时,我们希望你能仔细阅读smart-doc官方码云的wiki文档。我们将smart-doc及其插件的 每一个配置项和可能在日常中遇到的问题都整理到了文档中。仔细阅读文档就是对开源项目最大的支持。
查看快速开始 了解详情
JAVA
注释。Spring MVC
、Spring Boot
、Spring Boot Web Flux
(Controller
书写方式)、Feign
。Callable
、Future
、CompletableFuture
等异步接口返回的推导。JavaBean
上的JSR303
参数校验规范,包括分组验证。JSON
请求参数的接口能够自动生成模拟JSON
参数。JSON
返回值示例。Markdown
、HTML5
、Word
、Asciidoctor
、Postman Collection
、OpenAPI 3.0
。 开放文档数据,可自由实现接入文档管理系统。Jmeter
性能测试脚本。Maven
、Gradle
插件式轻松集成。Apache Dubbo RPC
接口文档生成。Java
类Javadoc
文档生成。Git
管理项目的变更增量文档生成。debug
接口调试html5
页面完全支持文件上传,下载(@download tag
标记下载方法)测试。GRPC
smart-doc
+ Torna 组成行业领先的文档生成和管理解决方案,使用smart-doc
无侵入完成Java
源代码分析和提取注释生成API
文档,
自动将文档推送到Torna[ˈtɔːrnə]
企业级接口文档管理平台。
Torna是由smart-doc官方独家推动联合研发的企业级文档管理系统,因此smart-doc官方不会对接其它任何的外部文档管理系统,例如像showdoc、yapi 之类的对接请自定内部处理,也不要再给我们提其他文档系统对接的PR。我们核心是把smart-doc+Torna的这套方案打造好。
如果你需要自己构建smart-doc
,那可以使用下面命令,构建需要依赖JDK 1.8+
。
mvn clean install -Dmaven.test.skip=true
smart-doc
is under the Apache 2.0 license. See
the LICENSE file for details.
注意: smart-doc
源代码文件全部带有版权注释,使用关键代码二次开源请保留原始版权,否则后果自负!
排名不分先后,更多接入公司,欢迎在https://gitee.com/smart-doc-team/smart-doc/issues/I1594T 登记(仅供开源用户参考)
感谢JetBrains SoftWare 免费的开源授权。
愿意参与构建smart-doc
或者是需要交流问题可以扫描微信二维码发送smart-doc
备注信息后管理员拉进群,常见问题答疑
关注微信公众号,了解社区动态和更多技术分享
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。