源码属性

授权 开源
大小 2.65MB
语言 Java

源码简介

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。

 

功能特点

1、零注解、零学习成本、只需要写标准JAVA注释。

2、基于源代码接口定义自动推导，强大的返回结构推导。

3、支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign、JAX-RS。

4、支持Callable、Future、CompletableFuture等异步接口返回的推导。

5、支持JavaBean上的JSR303参数校验规范，包括分组验证。

6、对JSON请求参数的接口能够自动生成模拟JSON参数。

7、对一些常用字段定义能够生成有效的模拟值。

8、支持生成JSON返回值示例。

9、支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。

10、支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 开放文档数据，可自由实现接入文档管理系统。

11、支持导出错误码和定义在代码中的各种字典码到接口文档。

12、支持Maven、Gradle插件式轻松集成。

13、支持Apache Dubbo RPC接口文档生成。

14、debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

 

组合推荐

smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档，自动将文档推送到Torna企业级接口文档管理平台。

Torna是由smart-doc官方独家推动联合研发的企业级文档管理系统，因此smart-doc官方不会对接其它任何的外部文档管理系统，例如像showdoc、yapi 之类的对接请自定内部处理，也不要再给我们提其他文档系统对接的PR。我们核心是把smart-doc+Torna的这套方案打造好。

如果你需要自己构建smart-doc，那可以使用下面命令，构建需要依赖Java 1.8。

mvn clean install -Dmaven.test.skip=true
下载声明：
  • 本站资源如无特殊说明默认解压密码为www.ymkuzhan.com建议使用WinRAR解压；
  • 本站资源来源于用户分享、互换、购买以及网络收集等渠道，本站不提供任何技术服务及有偿服务，资源仅提供给大家学习研究请勿作它用。
  • 赞助本站仅为维持服务器日常运行并非购买程序及源码费用因此不提供任何技术支持，如果你喜欢该程序，请购买正版!
    • 版权声明：
  • 下载本站资源学习研究的默认同意本站【版权声明】若本站提供的资源侵犯到你的权益，请提交版权证明文件至邮箱ymkuzhan#126.com(将#替换为@)站长将会在三个工作日内为您删除。
    • 免责声明：
  • 您好，本站所有资源(包括但不限于：源码、素材、工具、字体、图像、模板等)均为用户分享、互换、购买以及网络收集而来，并未取得原始权利人授权，因此禁止一切商用行为，仅可用于个人研究学习使用。请务必于下载后24小时内彻底删除，一切因下载人使用所引起的法律相关责任，包括但不限于:侵权,索赔,法律责任,刑事责任等相关责任,全部由下载人/使用人,全部承担。以上说明,一经发布视为您已全部阅读，理解、同意以上内容，如对以上内容持有异议，请勿下载，谢谢配合！支持正版，人人有责，如不慎对您的合法权益构成侵犯，请联系我们对相应内容进行删除，谢谢！