程序员最讨厌的两件事：

1. 写文档

2. 别人不写文档

写文档、维护文档比较麻烦，而且费时，还会经常出现 API 更新了，但文档还是旧的，各种同步不一致的情况，从而耽搁彼此的时间，大多数开发人员不愿意写 API 文档。

Eolink Apikit 为后端工程师提供 API 文档的创建与自动化生成、快速接口调试、以及 API 文档版本管理功能，协助后端工程师快速编写文档，调试接口，以及支持版本控制恢复历史记录。

通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好接口文档，接口调试、数据 Mock、接口测试就可以直接使用，无需再次定义。接口文档和接口开发调试使用同一个工具，接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确！

1、创建 API 文档

1. 点击“+ 添加API”按钮后，系统会新开一个新建API的标签。

2. 在新页面中填写API文档的信息，居然可输入信息如下。

3. 点击左上角的保存按钮即可创建新的API文档。

2、自动化生成 API 文档

该功能可通过配置数据源信息，实现基于数据源的API信息自动生成API文档。当前支持5种数据源：Swagger URL、apiDoc、Github、gitlab、码云。

1. 点击“+ 添加来源”后，系统弹窗中可选择5种数据源，可选择其中一种。（此处以推荐的“通过 Swagger URL”来举例）

2. 选中来源类型后，根据提醒填入来源名称和对应的swagger.json访问地址即可。注意该访问地址需要允许外网访问方可使用。

3、快速接口调试

1. 已有 API 文档快速测试

如果该接口已经在Apikit上创建了文档，则可以直接在文档内选择测试子TAB，进行快速测试。

2. 未有文档临时测试

如果未创建该接口文档，仅临时调试接口，则可创建API快速测试页面。可在这个页面输入接口相关的信息并进行快速测试。

若测试没问题，可点击右上角的“保存为新API”，快速把测试数据保存为API文档，方便下次调试。

4、API 文档版本管理

API文档的版本管理有两类，单API文档的编辑历史记录，以及项目级API文档的版本管理。

1. API 文档历史记录

点击API文档详情页右侧工具栏中的“历史记录”图标按钮，即可查看该文档的所有历史编辑记录。

在历史记录列表中，可对该文档过往的历史记录进行对比、查看备注、以及恢复该历史记录的内容。

2. 项目级版本管理

Eolink Apikit 提供项目级的版本管理功能，可以对项目进行打版本，保存一份当前项目所有API文档的快照。以便进行版本对比和分支版本管理。

点击“+ 添加版本”按钮，并输入版本号后点击确认，系统会对当前项目创建新的版本快照。

可随时查看某个版本的所有API文档信息，并可对多个版本进行版本对比。

支持把某个版本直接复制成新项目进行分支版本管理，或把历史版本数据进行全局导出。

无论使用什么语言开发，Eolink Apikit 都可以统一规范地管理起来，并提供强大的文档管理、协作、测试、分享功能。

• 自动生成 API 文档，并支持动态更新；

• 首创的版本管理、差异对比、变更通知；

• 强大的自定义请求校验与响应，便于前后端对接和集成测试等场景；

• 在线分享 & 导出，版本管理与评论，方便开发协；

• 支持多层级项目权限管理，支持自定义角色与权限。