[MacOS APP] 可能是 Mac 上颜值最高的接口文档生成工具

2020-10-11 06:08:30 +08:00
 whitecosm0s
2784 次点击
所在节点    分享创造
4 条回复
whitecosm0s
2020-10-11 06:25:26 +08:00
大家好,RabiAPI 原本是我上班时开发的一个内部服务,用于自动生成各种微服务项目的接口文档,现在我把它做成了一个独立的,完全离线使用的 MacOS App 。

由于公司里用的是自研的微服务框架,所以 Swagger 这类框架无法直接使用,Javadoc 对于前端是基本看不懂的,作为后端也不愿意使用 YAPI 这种类似填 Excel 表格的工具,因为微服务一个接口上百个字段非常普遍,这是我当时开发这个工具的主要原因。

这个工具的原理是通过静态分析扫描源代码并分析语法结构,提取可以生成文档的部分,例如 javadoc 注释,框架相关的注解等等,生成文档前不需要构建和编译,也不需要配置任何东西。

项目介绍: https://github.com/RabiAPI/RabiAPI-Support

## 支持的框架和注解

- Java Interface
- Spring Boot 注解
- Jax-RS 注解
- Swagger 2.0 注解

## 支持的导出格式

- markdown
- asciidoc
- PNG 图片

## 下载地址

- [Mac App Store]( https://apps.apple.com/cn/app/id1524200727)

## 付费方式

- 免费版本,最多同时使用三个项目
- 按月订阅,¥12.00 / 每月,自动续期
- 按年订阅,¥98.00 / 每年,自动续期

## 联系地址

- QQ 产品交流群:244365684
- 邮箱: superwhitecosmos@gmail.com
whitecosm0s
2020-10-11 06:26:46 +08:00
第一次发帖,点击预览的时候不小心点到了创建,只好写在回复里了,抱歉。
balabalaguguji
2020-10-11 09:19:11 +08:00
何不试下易文档,专业做接口文档管理的 https://easydoc.top
whitecosm0s
2020-10-11 11:01:47 +08:00
@balabalaguguji 这个工具可以和所有 wiki 类的产品配合使用,把接口文档导出到 markdown 再复制上去,提高维护效率^_^

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/713838

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX