java接口文档生成工具_无需额外注解的文档生成工具

  • Post author:
  • Post category:java


767f7daa2da670e3e0a3dc3af851282d.png

大家好,我是章鱼猫。

今天给大家推荐的这个开源项目,超级棒,是一个无需额外注解的 SpringBoot API 文档生成工具。

f9d538d69f4f567221eae99071e6d0b8.png

这个开源项目的作用就是:你只管好好写代码,生成 Api 文档的工作就可以交给 JApiDocs 了,你不需要再为额外编写和维护文档而烦恼。

功能特性如下:

1、代码即文档

JApiDocs 是通过直接解析 SpringBoot 的源码语法来工作的,所以只要 Controller 的语法符合一定的代码规范,有合理的注释,就可以直接导出文档。

2、支持导出 HTML

便捷的导航和接口查看界面;可本地预览,或者部署到 HTTP 服务器。推荐部署到服务器,方便前后端展开协作。

3、同步导出客户端 Model 代码

支持导出 Android 端的 Java 和 iOS 端的 Object C Model 代码,减少前端程序员的重复编码工作。

4、更多特性

支持接口搜索;支持不同版本和英文文档;自定义扩展等。

看完功能特性之后,是不是感觉很强大呢?不仅如此,文档还非常的简洁。

1096e2beac90cd0300caad5018a0ec80.png

为了让大家快速上手,开源项目的作者还专门为大家准备了一份极简的文档说明,确保你在几分钟就能用上 JApiDocs。

是不是很好呢?赶紧去支持一波吧!

开源项目地址:

https://github.com/YeDaxia/JApiDocs

开源项目作者:

叶大侠

最后,照旧安利一波我们的公众号:

「GitHub 精选」

,目前每天都会推荐一篇优质的开源项目文章,主要分享比较实用或有趣的开发工具与开源项目。我们的目标是:

挖掘开源的价值

。这个公众号超级值得大家关注。