就像汽车行业要达到一定规模，企业只能生产一个零件。软件行业现在已经足够大了，尤其是当你接受所谓“软件正在吞噬世界”的东西时。因此，就像汽车行业不再自己生产钢铁一样，大多数公司都希望利用API提供更好的服务来增强他们的产品和服务。——————BruceDavie，《计算机网络：系统方法》API标准化数据传输能力的作者，可以轻松支持支付处理、运输服务、信息传递、电子商务平台等。随着信息技术的蓬勃发展，API的应用越来越广泛。了解和掌握API的使用已经成为程序员的必修课！本文将指导您完成QuickStartAPI。演示工具：一站式API开发协作平台——易联Apikit快速学习API管理工具1.创建API项目在API接口研发管理产品中，所有的API接口都是以项目的形式进行管理的，所以首先需要创建一个API管理项目。除了创建API项目，您还可以创建项目组来对项目进行分类或设置统一的用户操作权限。手动创建项目输入项目名称、项目类型，点击确定！当然，您也可以选择导入第三方产品数据。除了手动创建项目，系统还提供一键导入Swagger、Postman、RAP、YAPI等产品数据。在API研发管理项目列表页面，点击导入按钮。几乎支持所有类似的第三方。产品支持导入文件的后缀名是EolinkAPI研发管理完全支持的。jsonPostmanV2支持导入API基本信息，超过10级分组的API数据将不会被导入。jsonSwaggerV2支持导入API基础信息。jsonSwaggerV3支持导入API基础信息。jsonRestClient支持导入API基础信息。jsonRAP支持导入API基础信息。jsonYAPI支持导入API基础信息。邮编2。添加协作成员您可以将团队成员添加到项目中以进行协作。注意：成员在添加到项目之前无法看到项目内容。进入项目人员管理页面，点击添加协作成员按钮，在弹窗中选择需要添加的成员和分配的角色。系统默认有项目管理员等角色，默认只读，可编辑。也可以根据需要新建自定义角色：角色名称权限范围项目管理员在项目中拥有最高权限，可以设置其他成员的权限rolesonlyRead成员在项目中具有只读权限，可编辑成员具有已读-项目中写权限Customrole自定义权限3.创建API文档在API研发管理产品中，几乎所有的协同工作都是围绕API文档进行的。在接触了大量客户后，我们发现采用文档驱动的协作模式比先开发后维护文档更好，团队协作效率和产品质量都可以得到提升。因此，我们建议大家尽量基于文档工作，使用文档驱动的方式来减少很多无意义的沟通成本。产品支持多种创建API文档的方式：手动创建文档：适合所有团队；根据代码注解自动生成文档：适用于已经使用或正在使用Swagger产品自动生成文档的团队。从代码模板快速创建API文档：适用于所有团队。创建API文档后，您可以随时查看API的变化，根据API文档发起API测试，编写API测试用例，使用MockAPI等。下图是系统管理的API文档，可以详细查看API描述信息、变更历史、测试用例、MockAPI等内容。手动创建API点击项目详情页面左侧的API文档功能，进入API管理页面，点击添加API，即可进入API创建页面。私有云产品比在线SaaS产品支持更多的API协议，如TCP、UDP、SOAP、HSF等。在API编辑页面，可以填写API文档、返回数据、附加说明等信息，可以切换通过顶部的标签。填写API文档，在API描述页签填写API请求路径、API名称、标签、负责人等基本信息。API状态：方便会员查看API当前状态，通知状态流转；Tag标签：可作为API的注释或过滤条件；负责人：当API文档内容发生变化时，负责人会自动收到APIChangeNotifications。API请求参数设置请求头（requestheader）可以输入或导入请求头。批量导入的数据格式为key:value，每行的header信息，例如：1Connection:keep-alive2Content-Encoding:gzip3Content-Type:application/json4Date:Mon,30Dec201920:49:45GMT设置requestBody（请求体）请求体提供五种类型：Form-data（表单）JsonXMLRaw（自定义文本类型数据）Binary（字节流，文件参数）。对于Form-data（表单）、Json、XML等数据类型，可以参考预先编辑好的数据结构快速填写内容。设置Query参数Query参数是指地址栏后面跟一个问号？后面的参数，比如下面地址中的user_name参数：1/user/login?user_name=jackliu批量导入的数据格式是?key=value...，多个参数用&隔开，比如：1api.eolinker.com/user/login?user_name=jackliu&user_password=hello设置REST参数REST参数是指地址栏中用斜杠/隔开的参数，比如下面地址中用大括号括起来的user_name和user_password参数：1/user/login/{user_name}/{user_password}2请注意，您只需要在URL中用{}将REST参数括起来。对于API文档和测试，下表中的参数名称不需要使用{}。API响应内容设置响应头（responseheader）您可以输入或导入响应头。批量导入的数据格式为key:value，每行的header信息，例如：1Connection:keep-alive2Content-Encoding:gzip3Content-Type:application/json4Date:Mon,30Dec201920:49:45GMT设置响应内容（responsebody）响应内容的写法与请求参数类似。响应内容提供四种类型：JsonXMLRaw（自定义文本类型数据）Binary（字节流，文件参数）对于Json、XML等数据类型，您可以通过引用预先编辑好的数据结构快速填写内容。系统还提供导入功能，方便您快速导入参数信息。4.发起API测试页面入口进入API文档详情页面，点击上方的测试标签进入API测试页面，系统会自动生成测试界面，并根据API文档填写测试数据。填写请求参数首先填写请求参数。请求标头您可以输入或导入请求标头。批量导入的数据格式为key:value，每行的header信息，例如：1Connection:keep-alive2Content-Encoding:gzip3Content-Type:application/json4Date:Mon,30Dec201920:49:45GMTrequestbody请求body提供五种类型：Form-data（表单）JSONXMLRaw（自定义文本类型数据）Binary（字节流，文件参数）产品中提供的JSON和XML编辑器，当你在API文档中定义好时选择API请求数据结构，您只需要在测试界面填写各个字段的值，系统会自动将请求数据转换成相应的JSON和XML结构。Query参数Query参数是指地址栏后面跟问号？下面的参数，比如下面地址中的user_name参数：/user/login?user_name=jackliu批量导入的数据格式是?key=value，多个参数用&分隔，比如：api.eolinker.com/用户登录？user_name=jackliu&user_password=helloREST参数REST参数是指地址栏中用斜杠/分隔的参数，比如下面地址中的user_name和user_password参数：/user/login/{user_name}/{user_password}注意只需要要在URL中使用{}来括住REST参数，下面的请求参数名中不需要使用{}。处理脚本分为前置脚本和后置脚本，分别对应API请求前和返回数据后两个阶段。您可以通过编写Javascript代码在API前脚本中更改请求参数或在API后脚本中更改返回结果。脚本常用于以下情况：API请求前对请求参数进行复制、加密、解密，如对body整体签名，API返回结果后解密等。API发起的API请求会依次经历以下过程。其中，如果您还没有编写相应的API脚本，则API脚本处理阶段将被跳过。查看测试结果填写好请求参数后，点击测试按钮即可获得测试报告。报告包括以下内容：返回头返回内容实际请求头实际请求内容请求时间分析5.创建MockAPI瀑布流中的MockAPI是什么在开发模式下，如果前端开发者需要连接页面，后面-端需要先完成API的开发，所以前后端的开发进度会相互影响。使用MockAPI，可以预先编写API数据生成规则，系统会动态生成API返回数据。开发者通过访问MockAPI获取页面所需的数据，完成对接工作。项目正式发布时，将MockAPI的地址前缀替换为实际访问地址即可。因为同一个项目中MockAPI的地址前缀是相同的（比如mock.eolinker.com/uasyd1/...），所以MockAPI的地址前缀可以作为代码中的全局变量，只需要在项目上线时替换变量。值更改整个项目的API请求URL前缀。创建MockAPI进入API文档详情页面，点击MockAPI页签，点击新建MockAPI，在弹窗中填写MockAPI的触发条件和返回结果。触发条件支持请求头、请求体（Form-data、JSON）、Query参数等，下面的例子表示当Form-data参数中包含user_name=jackliu时，返回默认的JSON字符串。6.调用MockAPI进入MockAPI列表页面，点击调用地址复制到剪贴板，直接向代码中的API地址发起请求，获取响应结果。MockAPI对触发条件的优先级为：填写触发条件的优先级，效果高。当包含触发条件所需的参数时，将返回预期的结果。当触发条件中填写的所有MockAPI都无法触发时，触发触发器。UnconditionalMockAPI和lowreturnexpectedresult当以上两种情况都不能触发MockAPI时，系统会返回提示信息。此时请检查请求协议、请求方法、请求参数是否符合MockAPI的设置。注意：如果系统找不到匹配的MockAPI，则不会返回相应的结果。因此，在调用MockAPI时，必须保证请求的协议、请求方法（如GET、POST……）、参数值等能够命中预先设定的MockAPI触发条件。3.小结以上是一个快速入门API的实用小课堂。整体而言，Eolink在提升研发人员体验方面表现出色。前端、后端、管理者等不同角色，基于Eolinkapp，可以提供全新层次的专业开发能力，同时大大提高便捷性。人员只需专注于研发本身，无需花费过多精力管理API，从而提高团队的工作效率。当API可被多方（从内部开发人员到合作伙伴组织和客户）访问时，安全性成为一个关键焦点，您需要采取一切可能的步骤来保护敏感数据并确保正确分配和管理权限。基于EolinkAPI管理方案，这可以轻松实现。体验地址：一站式API开发协作平台-EolinkApikit
