共计 749 个字符,预计需要花费 2 分钟才能阅读完成。
API 文档是我的项目开发必备的文档之一,且随着我的项目一直的 API 化,API 文档也越发重要。因为 API 文档不仅蕴含 API 根本信息,还蕴含 API 示例等,并且测试人员也须要应用 API 文档对 API 进行测试,所以传统的 Office 文档曾经逐步不能满足咱们的需要,抉择一个弱小的 API 管理工具,是我的项目开发与前期保护的要害。
以 Eolinker 为例。作为国内当先的 API 全生命周期治理平台,Eolinker 在 API 文档方面做的十分杰出,联合了 API 文档所需的基本要素外,还具备其余弱小的性能,本文重点介绍 API 文档局部。
作为业余的 API 管理工具,Eolinker 以我的项目的形式治理 API 文档。在一个我的项目内,可查看 API 的各种信息,例如不同状态的 API 统计、是否通过测试等。
在 API 文档界面,简洁的分组与 API 列表不便疾速查找 API。
创立 API 时可填写字段蕴含了 API 文档根本信息与申请示例等,编写 API 文档无需设置文档格局,只须要在响应的中央填写阐明即可。
单个 API 文档能够查看到 API 的申请内容,包含参数阐明、标签、申请示例。该界面还反对设置 API 变更告诉,查看版本历史与版本比照等。除了 API 文档的内容外还反对疾速测试、生成测试用例、生成 MockAPI。
对于整个我的项目的 API,Eolinker 提供了状态码文档、版本治理、API 文档模板、数据结构等性能,不便疾速生成 API 文档。Eolinker 也反对疾速导入多个平台的 API 文档,还反对在线同步…
一个业余的 API 文档管理工具在满足 API 文档需要的同时,还必须思考到 API 的各个方面,这其中包含团队单干,可移植性等。在抉择 API 文档管理工具前,团队能够对我的项目进行评估,依据本人的需要抉择适合的文档工具。
应用地址:www.eolinker.com