检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买AP
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买AP
撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。
撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
Path不支持“存在”和“不存在”类型。 表达式支持Mock.js语法,具体使用方式可参考Mock语法说明。 返回响应 Mock服务支持从状态码、响应头、响应体三个维度配置请求的响应。 状态码:必填项,参考http状态码。 响应头:选填项,输入响应头的名称和值,配置希望返回的响应头。 响应体:选填项,支持json、xml及自定义文本格式。
Path不支持“存在”和“不存在”类型。 表达式支持Mock.js语法,具体使用方式可参考Mock语法说明。 返回响应 Mock服务支持从状态码、响应头、响应体三个维度配置请求的响应。 状态码:必填项,参考http状态码。 响应头:选填项,输入响应头的名称和值,配置希望返回的响应头。 响应体:选填项,支持json、xml及自定义文本格式。
info:检查状态码是否为1XX。 pm.response.to.be.success:检查状态码是否为2XX。 pm.response.to.be.redirection:检查状态码是否为3XX。 pm.response.to.be.clientError:检查状态码是否为4XX。
info:检查状态码是否为1XX。 pm.response.to.be.success:检查状态码是否为2XX。 pm.response.to.be.redirection:检查状态码是否为3XX。 pm.response.to.be.clientError:检查状态码是否为4XX。
填写“变更原因”,单击“提交”,提交API接口进入审核流程。 审核流程结束前,该提交审核的API接口将处于锁定状态,不可编辑和删除。 撤回审核 单击,弹出“接口审核”页面,默认可以查看项目中“待审核”状态的API接口列表。 选择需要撤回的API接口,单击操作栏的,进入“审核详情”页面,可查看接口变更前后的对比详情。
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
为该API资产添加分类属性,方便在大量创建API资产后,快速过滤和查找。 填写完API资产信息后,单击“立即创建”。 等待系统解析API文件,API资产所在行“状态”列如果显示“已上架”,说明解析完成,此时,API资产已成功分享至API中心门户网站。 父主题: API发布
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
授权使用CodeArts API 授权IAM账号 如果用户需要对所拥有的CodeArts API服务进行精细的权限管理,可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,可以: 根据企业的业务组织,在华为云账号中,给
授权使用CodeArts API 支持授权IAM账号和企业联邦账号使用CodeArts API。 约束与限制 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。