检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例,接口用例可以记录请求参数,方便后续接口调试。 单击发送后,在返回响应中调试成功后,单击“保存为用例
在API调试页面修改请求参数,不能保存至API设计与API文档中。 返回响应 显示响应是否成功、响应时间、状态码、请求方式以及响应体信息和响应头信息。 保存为用例 CodeArts API支持将调试结果保存为接口用例,接口用例可以记录请求参数,方便后续接口调试。 单击发送后,在返回响应中调试成功后,单击“保存为用例
表示接口返回的响应头。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应头中的token等于abcd。 设置方法:设置来源为响应头,属性为token(前提条件响应头有token),设置比较符为等于(字符串、不区分大小写),设置目标值为abcd。 响应码 表示接口返回的响应码。
表示接口返回的响应头。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应头中的token等于abcd。 设置方法:设置来源为响应头,属性为token(前提条件响应头有token),设置比较符为等于(字符串、不区分大小写),设置目标值为abcd。 响应码 表示接口返回的响应码。
后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据,如果设计修改则需要手工修改Mock数据。 测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。
单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。
后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据,如果设计修改则需要手工修改Mock数据。 测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。
两种身份提供商的适用场景及配置方法可参照身份供应商概述。 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 父主题: 使用CodeArts API服务
两种身份提供商的适用场景及配置方法可参照身份供应商概述。 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 父主题: 使用CodeArts API服务
分组 当测试流程中多个步骤存在关联关系时,可以对测试步骤进行归类,并放到同一分组中。通过对测试步骤的分组,让测试场景具备更好的可读性和操作性。 进入接口自动化用例编辑的“脚本”页签,单击“分组”。 输入分组名称,并拖拽相关的测试步骤到分组。 分组中可添加URL请求、判断、等待、循环。
分组 当测试流程中多个步骤存在关联关系时,可以对测试步骤进行归类,并放到同一分组中。通过对测试步骤的分组,让测试场景具备更好的可读性和操作性。 进入接口自动化用例编辑的“脚本”页签,单击“分组”。 输入分组名称,并拖拽相关的测试步骤到分组。 分组中可添加URL请求、判断、等待、循环。
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
API保证API各阶段数据高度一致,为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API,开发者可以高效、规范、准确地培育并呵护自己的API,便捷参与API经济。 图1 CodeArts API平台拓扑图
单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码,单击右上角,可一键复制并直接粘贴,支持编辑修改和代码格式化。 生成业务代码 单击“生成代码”下拉框,选择“生成业务代码”,弹出“生成业务代码”对话框。 根据需要选择