检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
建接口下的Mock规则。设计并创建一个Mock规则,请参见Mock规则设计。 搜索规则 “Mock规则管理”页面的接口支持模糊搜索 :输入接口名称或路径名的关键字,即可搜索对应接口。 自定义匹配优先级 在匹配规则的时候,按照从上到下的顺序依次进行匹配;在匹配到符合条件的规则时,返回当前规则的响应内容。
用例调试 在“测试用例”页面,单击“调试”,开始执行测试用例。 查看运行结果 调试完成后,可快速查看具体用例执行成功或失败的用时。 单击单条结果记录,可查看执行的详细信息。 父主题: 测试用例管理
用例调试 在“测试用例”页面,单击“调试”,开始执行测试用例。 查看运行结果 调试完成后,可快速查看具体用例执行成功或失败的用时。 单击单条结果记录,可查看执行的详细信息。 父主题: 测试用例管理
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。
数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。 父主题: 功能相关
基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码,单击右上角,可一键复制并直接粘贴,支持编辑修改和代码格式化。
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。 新建快捷调试 单击
基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码,单击右上角,可一键复制并直接粘贴,支持编辑修改和代码格式化。
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。 选择项目角色,然后单击“完成”即可成功添加。
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。 选择项目角色,然后单击“完成”即可成功添加。
PI托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API各阶段数据高度一致,为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API,开发者可以高效、规范、准确地培育并呵护自己的API,便捷参与API经济。 图1
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。