用 API Factory 产品生成 API 文档

什么是 API Factory ？

API Factory（API 快速生成工厂） 能够帮助我们直接从各种常见关系型数据库、NoSQL 数据库、大数据库中间件中生成统一格式的 HTTP Restful API。

通过 API Factory，我们可以通过编写 SQL 脚本或通过 UI 方式直接创建一个高性能的数据库操作 API 。

API Factory 常见的使用场景有哪些？

• 快速创建数据操作 API

针对较简单的前端业务，可以根据数据库快速创建数据操作 API （增删改查），直接将 API 提供给前端使用，不需要额外搭建后端。

• 代替业务数据库操作 API

针对一般项目内的数据库操作，可以替代业务的数据库操作API，让业务专注于更复杂的业务逻辑。

• 无需关注数据库类型调用 API

作为数据平台，关联底层数据库以及上层业务逻辑。所有的上层业务可以通过该平台调用 API 而不需要关注数据库的类型和代码实现。

如何利用 API Factory 产品生成 API 文档？

创建项目

进入项目管理页面，点击新建项目按钮：

在弹窗中选择数据源类型：

并且输入项目的名称、标识、访问前缀等信息，点击保存即可。

项目信息栏各项解释为：

• 项目唯一标识

仅允许英文、数字、下划线。项目唯一标识用于区别其他您的项目，并且在对接其他系统时（如日志系统）以该名称作为标志。

• 项目内 API 请求地址前缀

指的是该项目内所有 API 访问时都需要加上该请求前缀，仅支持一级路经，比如支持 /a，但是不支持 /a/b，如果有区分多级路径的需求，建议使用下划线进行分隔，如 /a_b。

通过界面创建 API

在创建 API 之前，需要先创建项目访问的数据源配置，有关教程可以自行查看学习：数据源管理

但与通过语句创建 API 不同的是，在 UI 模式中，系统会自动读取相应数据源的数据结构，我们可以在表格中选取 需要筛选的字段 和 判断条件 等。

需要注意的是，并非所有类型的数据源都有通过 UI 模式创建 API 的功能，该功能仅针对关系型数据库，对于无法准确获得数据结构的 NoSQL 数据库（如 MongoDB）则不支持该功能。

进入项目内的 API 管理页面，点击新建 API 按钮的下拉菜单，选择通过 UI 创建 API：

进入 API 编辑页面后，输入 API 的相关信息并点击保存即可。

• API 唯一标识

用于在对接第三方日志系统时使用，系统默认会自动生成一个唯一标识，如无需要可不修改。

• API Path

是 API 访问的路径，实际访问 API 时的地址为：域名（ IP+端口号）+ 项目请求地址前缀 + API Path。

例如：

1.1.1.1:8088/project_path/api_path

---

以上，本文通过介绍什么是 API Factory 产品、API Factory 产品的使用场景 以及 如何通过 API Factory 产品根据数据库生成 API 文档，三个方面来阐述如何合理利用 API Factory 来帮助我们节省大量的编写基础数据操作 API 的时间和管理成本。

通过使用好用的 API Factory 产品可以帮助我们书写文档事半功倍。

这里我推荐演示工具 Eolink，它能设计、管理 API ，一键生成 API 文档，除此之外还能直接打通接口测试，一键发起 API 测试，方便快捷且功能强大。