文件名称：【Eolink使用教程_API研发管理】1.3快速入门_创建API文档_全球领先API管理平台Eolink.pdf
文件大小：535KB
文件格式：PDF
更新时间：2022-06-17 15:15:58
api 创建 文档 接口 研发
在 API 研发管理产品中，几乎所有的协作工作都是围绕着 API 文档进行的。 我们在接触了大量的客户后发现，采用 文档驱动 的协作模式会比 先开发、后维护文档 的方式更好，团队协作效率和产品质量 都能得到提高。因此我们建议您尝试基于文档来进行工作，使用 文档驱动 方式来降低大量无意义的沟通成本。 产品支持几种创建API文档的方式： 1. 手动创建文档：适合所有团队； 2. 根据代码注解自动生成文档：适合使用过或正在使用Swagger产品来自动生成文档的团队。 3. 根据代码模板快速创建API文档：适合所有团队。 当您创建了 API 文档之后，您可以随时查看 API 的改动情况、根据 API 文档发起 API 测试、编写 API 测试用例、使用 Mock API等。