正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
产品功能 表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全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击主页面的“新建API接口”选项,创建http类型接口。
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选
管理成员与角色 项目创建完成后,当用户需要团队协作来完成这个项目时,可以邀请同一个华为云账号下的其他IAM用户加入项目,并给成员分配角色。 前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限,可以添加成员或将成员移出项目。 拥有“
快速入门 登录CodeArts API 使用华为云账号登录CodeArts API,系统默认为新用户新建“示例项目”并进入项目,用户可基于“示例项目”进行快捷调试。 新建快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试
环境&参数 在自动化测试中,通常存在多个测试环境,每个测试环境的环境参数值会有不同,例如域名、账号等。这些参数常会在测试脚本中被使用到,如果将这些参数硬绑定到测试脚本中,脚本的冗余度很高,复用度很低。 合理的测试设计要求分离测试逻辑和测试数据,实现测试逻辑的最大化复用,增强测试用
环境&参数 在自动化测试中,通常存在多个测试环境,每个测试环境的环境参数值会有不同,例如域名、账号等。这些参数常会在测试脚本中被使用到,如果将这些参数硬绑定到测试脚本中,脚本的冗余度很高,复用度很低。 合理的测试设计要求分离测试逻辑和测试数据,实现测试逻辑的最大化复用,增强测试用
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
授权使用CodeArts API 授权IAM账号 如果用户需要对所拥有的CodeArts API服务进行精细的权限管理,可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,可以: 根据企业的业务组织,在华为云账号中,给
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。