在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
Smart-Doc ProjectIntroducesmart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、PostmanCollection2.0+、OpenAPI 3.0+的文档。 $\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$
查看快速开始 了解详情 Features
Best Practicesmart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档,自动将文档推送到Torna企业级接口文档管理平台。
Building如果你需要自己构建smart-doc,那可以使用下面命令,构建需要依赖Java 1.8。 mvn clean install -Dmaven.test.skip=true TODO
Licensesmart-doc is under the Apache 2.0 license. Seethe LICENSE file for details. 注意: smart-doc源代码文件全部带有版权注释,使用关键代码二次开源请保留原始版权,否则后果自负! Who is using
Award situation
Acknowledgements感谢JetBrains SoftWare 为本开源项目提供的免费Open Source license。 Contact愿意参与构建smart-doc或者是需要交流问题可以加入qq群:
Donate如果您觉得我们的开源软件对你有所帮助,请扫下方二维码打赏我们一杯咖啡 |
请发表评论