检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买APIG实例。如果没有购买过APIG实例,可以在CodeArts API上通过以下操作步骤完成购买。 单击“项目设置
实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买APIG实例。如果没有购买过APIG实例,可以在CodeArts API上通过以下操作步骤完成购买。 单击“项目设置
准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。 如果前置条件的数据需要在测试阶段中引用,可以使用参数传递将数据参数化后,传递给测试阶段引用,详见响应提取。 测试阶段:测试步骤。
内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作将立即生效,不再需要审核,同时清空未生效的API修改记录和未审批通过的提交审核记录。
息,如:文件大小、修改日期等。 PATCH(补丁):用于对资源进行局部更新。PATCH请求类似于PUT请求,但是只更新资源的一部分。 TRACE(跟踪):用于建立与代理服务器的隧道连接,通常用于进行安全的SSL/TLS加密通信。 接口请求参数 Params、Path、Header、Cookies
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作将立即生效,不再需要审核,同时清空未生效的API修改记录和未审批通过的提交审核记录。
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
息,如:文件大小、修改日期等。 PATCH(补丁):用于对资源进行局部更新。PATCH请求类似于PUT请求,但是只更新资源的一部分。 TRACE(跟踪):用于建立与代理服务器的隧道连接,通常用于进行安全的SSL/TLS加密通信。 接口请求参数 Params、Path、Header、Cookies
发布历史 记录了客户端版本发布历史,包括新特性、问题修复及优化等内容,用户可以在该页面下载最新版本客户端。 版本号 操作系统 OS支持 更新内容 发布时间 下载链接 1.0.0 Windows X86 新特性: 客户端1.0.0版本正式发布,提供API表单化设计、文档管理、Moc
添加不需要检查的接口”对话框。 选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。
准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。 如果前置条件的数据需要在测试阶段中引用,可以使用参数传递将数据参数化后,传递给测试阶段引用,详见响应提取。 测试阶段:测试步骤。
便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。 移动Markdown(可选)。 单击并拖拽Markdown到目标目录后释放即可,移动成功后,目录树会自动刷新
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
添加不需要检查的接口”对话框。 选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。
便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,界面会自动跳转到文档页面,展示名称、正文,上方标签页的名称也会更新为Markdown文件名称。 移动Markdown(可选)。 单击并拖拽Markdown到目标目录后释放即可,移动成功后,目录树会自动刷新
操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。 修改成功后,页面中显示更新后的角色名称。 删除角色 单击角色名称后的,选择“删除自定义角色”。 在弹框中输入“YES”,单击“确定”。 删除成功后,页面中将不显示该角色。
操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。 修改成功后,页面中显示更新后的角色名称。 删除角色 单击角色名称后的,选择“删除自定义角色”。 在弹框中输入“YES”,单击“确定”。 删除成功后,页面中将不显示该角色。