接口文档是项目开发中必需的说明文档，接口文档编写有很多不同的方式，今天本文简单介绍一下常用的几种接口文档编写方法。
API 文档导入生成
使用接口文档工具 Eolink 演示 API 文档导入生成的过程。 Eolink 系统提供一键导入 Swagger 、 Postman 、 RAP 、 YAPI 等产品数据的功能。实现无负担从其他平台进行数据迁移。
支持导入.png
在项目详情页点击左侧 API 功能，进入 API 管理页面，直接点击下拉框选择导入 API 。
选择导入API.PNG
选择导入数据类型.png
配置导入规则：
选项说明：
-
将 API 导入到以下分组：选择对应的 API 分组
-
将新生成的 API 文档状态设置为：可以将导入 API 文档设置对应状态
-
将发生变更的 API 文档状态设置为：对已发生变更状态的 API 文档，可以更新指定的文档状态
-
将新生成的或发生变更的 API 文档的版本号设置为：可以将导入 API 文档设置指定的 API 版本号
配置导入规则.PNG
设置好导入配置规则后，点击确定会显示成功提示， 并在右侧栏显示我的任务队列进行中，当状态显示完成就导入成功了。
如下图：
在任务队列中查看任务进展.png
刷新界面就可导入 API 数据：
API列表.PNG
自动生成文档
通过使用接口文档工具 Eolink 演示如何自动生成文档。
用户可以实现给项目关联的 Swaqger 生成的 JSON 文件地址，Eolink 的 API 研发管理平台就能够远程读取 Swagger JSON 文件地址并自动生成 API 文档。
进入 API 管理与测试，选择项目，左侧栏的其他可以看到 API 文档生成。
自动生成API文档.PNG
添加来源，在弹窗中选择通过 Swagger URL 生成 API 文档 ，然后点击下一步：
添加来源.PNG
输入 Swagger 生成的 JSON 地址，注意该 JSON 地址需要能够通过网络访问，并且该地址返回的数据需要是 JSON 类型的数据，否则会提示无法访问该地址。
完善配置.PNG
配置完成后，界面会提示配置完成。此时您可以通过当前页面点击 同步 按钮，或通过 Open API 触发同步操作。
自动同步生成API.PNG
使用 API Factory 产品根据数据库生成 API 文档
API Factory（ API 快速生成工厂）能够帮助用户直接从各种常见关系数据库、 NoSQL 数据库、大数据库中间件中生成统一格式的 HTTP Restful API 。通过 API Factory，您可以通过编写 SQL 脚本或通过 UI 方式直接创建一个高性能的数据库操作 API 。
以上三种方法是生成 API 文档最常见的方法，通过使用一款好用的接口文档工具实现 API 文档导入生成、自动生成 API 文档，以及使用 API Factory 产品数据库生成 API 文档，让开发在书写文档过程中不再痛苦，提高前后端的开发效率。
网友评论