检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
创建成功,在“自定义角色”中显示新的角色名称。 对新创建的角色,可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。 修改成功后,页面中显示更新后的角色名称。
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可以编辑Mar
建接口下的Mock规则。设计并创建一个Mock规则,请参见Mock规则设计。 搜索规则 “Mock规则管理”页面的接口支持模糊搜索 :输入接口名称或路径名的关键字,即可搜索对应接口。 自定义匹配优先级 在匹配规则的时候,按照从上到下的顺序依次进行匹配;在匹配到符合条件的规则时,返回当前规则的响应内容。
建接口下的Mock规则。设计并创建一个Mock规则,请参见Mock规则设计。 搜索规则 “Mock规则管理”页面的接口支持模糊搜索 :输入接口名称或路径名的关键字,即可搜索对应接口。 自定义匹配优先级 在匹配规则的时候,按照从上到下的顺序依次进行匹配;在匹配到符合条件的规则时,返回当前规则的响应内容。
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。 新建快捷调试 单击
数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
s TestPlan的计费规则。 用户开通“CodeArts体验版”后,支持免费试用“API测试”的相关特性,具体以CodeArts TestPlan的试用公告为准。 功能涉及到使用华为云的相关资源,例如API发布,需要预先购买APIG实例,则需要支付相应的资源使用费用,具体购买操作请参照插件管理。
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块,不能单独使用类库里的某个子模块,具体看本文档末尾说明。 atob(v2.1.2):用于Base64解码。
Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块,不能单独使用类库里的某个子模块,具体看本文档末尾说明。 atob(v2.1.2):用于Base64解码。
说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介 API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方
第三方URL 第三方URL地址。 Auth 推送URL的认证类型。 No Auth:表示无认证。 API Key:使用 API Key 进行身份验证。 Bearer Token:用于身份验证的访问令牌,授权持有者(Bearer)访问资源的权限。 Basic Auth: 基本认证,一种H
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。
导入版本 选择需要导入的API版本。 根目录 选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。 单击“确定”,完成定时导入任务创建。 在“定时导入”页面单击“是否启用”,设置启用/关闭定时任务。启用定时任务后开始计时,根据设置的时间间隔完成导入任务。
导入版本 选择需要导入的API版本。 根目录 选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。 单击“确定”,完成定时导入任务创建。 在“定时导入”页面单击“是否启用”,设置启用/关闭定时任务。启用定时任务后开始计时,根据设置的时间间隔完成导入任务。