[送兑换码] MacOS 上的接口文档生成和调试工具 RabiAPI 更新 1.3.3 版本，集成 ApidocJS 框架，支持对所有主流编程语言自动生成 API 文档！

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

爱意满满的作品展示区。

这是一个创建于 1363 天前的主题，其中的信息可能已经有所发展或是发生改变。

RabiAPI 之前仅支持 Java 项目，很多人反馈希望能够支持其它语言。本次更新中集成了 apidoc-core 框架。可以直接添加使用了 apidoc 的项目。

** 应用原价 60 元，目前半价 30 元骨折销售中 **

购买地址: https://apps.apple.com/cn/app/rabiapi/id1524200727

详细介绍: https://github.com/RabiAPI/RabiAPI-Support

其它更新:

Http Client 增加参数是否必填提示，仅作提示用。
Http Client 增加是否存在参数提示，如果相关菜单存在参数，作蓝色圆点标记
优化在 13 寸分辨率下的显示效果
支持多窗口，通过 command + N 打开新窗口

ApidocJS 简介

ApidocJS 是一个通过注释信息直接生成 API 文档的开源框架，通过正则表达式解析特定写法的注释并生成一个静态站点，理论上支持所有语言。

写法示例，定义一个 GET 请求

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */
 
 ... code

写法基本就是这样，通过自定义的 Tag 和格式填写 API 信息。

优点: 写法简单，对代码无侵入，无额外依赖，适合简单 API 接口。

缺点: Postman 和 Paw 均不支持 apidoc json 文件的导入，本身生成的静态站点仅具备展示功能。由于使用的是注释导致很难定义特别复杂的接口。

官网: https://apidocjs.com/

Github: https://github.com/apidoc/apidoc 目前 8.8K Star