一键生成 API 文档的妙招

82 阅读2分钟

一般接口文档编写完成后,就要开始编写调用接口的代码,很多开发团队都采用传统的通过接口文档的方式来编写接口。但在接口数量越来越多的当下,手写接口十分麻烦。

今天我们通过 Eolink 演示一种一键生成 API 文档的方法,给大家提供获取 API 文档的新思路,帮助大家快速生成接口文档。

在 Eolink 的 API 管理与测试页面中,点进 其他 并点击 API 代码生成 一栏。

API代码生成.png

从代码模板中选取所需的 API 代码,代码模块也可根据需要自行选择 全部、仅模型代码、仅接口代码、仅Support代码、仅模型和Support代码等配置信息,然后点击 生成代码 即可自行生成代码。

代码模块配置信息.png

Eolink 提供自动生成 API 代码文档的服务,通过选择 代码存放路径 来存放所需代码,可以看到 生成日志 中已经根据我们的需要生成好了代码文档,点击 下载代码 即可获取 API 代码文档。

自动生成代码.png

这样就能实现 API 代码文档的一键生成啦。

其实一键化自动生成 API 文档主要是不用再重新写调用代码,Eolink 中的 API 管理与测试服务十分完善,所生成的文档内容也比较详细,无需编写人员再进行手写注释。

如果你也和我一样需要快速生成API文档,不妨试试Eolink这款专为开发者设计的API协作平台,它能设计、管理API,一键生成 API 文档,除此之外还能直接打通接口测试,一键发起 API 测试,方便快捷且功能强大。

附上官网:www.eolink.com