检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展 CodeArts API Web版本需要安装浏览器扩展,通过浏览器扩展发送请求。 有调用数据库/本地代码、发送Cookie
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展 CodeArts API Web版本需要安装浏览器扩展,通过浏览器扩展发送请求。 有调用数据库/本地代码、发送Cookie
目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可
目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。
若来源是响应码,属性为空。详细介绍请参见响应码检查。 若来源是响应头,属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体(JSON),属性有两种填写方法: 普通提取表达式(非“$”开头),例如“item.name”。 取字段中的值,支持嵌套取值。详细介绍请参见响应体(JSON)检查。 从响
若来源是响应码,属性为空。详细介绍请参见响应码检查。 若来源是响应头,属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体(JSON),属性有两种填写方法: 普通提取表达式(非“$”开头),例如“item.name”。 取字段中的值,支持嵌套取值。详细介绍请参见响应体(JSON)检查。 从响
DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。
DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数
用户登录CodeArts API,可正常使用产品,但不可创建项目。 将授权用户添加至项目请参照管理成员与角色。 设置新建项目权限也可通过在CodeArts首页设置项目创建者完成权限设置。 软件开发生产线控制台权限DevCloud Console FullAccess及DevCloud Console
用户登录CodeArts API,可正常使用产品,但不可创建项目。 将授权用户添加至项目请参照管理成员与角色。 设置新建项目权限也可通过在CodeArts首页设置项目创建者完成权限设置。 软件开发生产线控制台权限DevCloud Console FullAccess及DevCloud Console
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
参数等信息,详细参照设置接口请求章节。 从postman文件导入 接口自动化测试用例支持通过导入Postman文件,生成测试步骤。 导入Postman文件需满足以下要求: 支持Postman Collection v2.1标准。 仅支持Postman请求方法、请求URL、请求头、请求体生成测试步骤。
参数等信息,详细参照设置接口请求章节。 从postman文件导入 接口自动化测试用例支持通过导入Postman文件,生成测试步骤。 导入Postman文件需满足以下要求: 支持Postman Collection v2.1标准。 仅支持Postman请求方法、请求URL、请求头、请求体生成测试步骤。
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。
说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介 API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关