检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开发者提供的一站式云端平台,即开即用,随时随地在云端交付软件全生命周期,覆盖需求下发、代码提交、代码检查、代码编译、验证、部署、发布,打通软件交付的完整路径,提供软件研发流程的端到端支持。CodeArts API属于软件开发生产线工具链的一部分,补齐了CodeArts的API设计
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码,单击右上角,可一键复制并直接粘贴,支持编辑修改和代码格式化。
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。 新建快捷调试 单击
设置Mock 默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。 选择项目角色,然后单击“完成”即可成功添加。
路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。 Mock选项 打开URL输入框右侧的MockURL按钮,开启Mock服务,接口路径的域名会变
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
PI托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API各阶段数据高度一致,为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API,开发者可以高效、规范、准确地培育并呵护自己的API,便捷参与API经济。 图1
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
IAM账号进入CodeArts API首页报错 IAM账号首次进入CodeArts API首页报错,需要给IAM账号进行授权。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用CodeArts
s API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。
Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块,不能单独使用类库里的某个子模块,具体看本文档末尾说明。 atob(v2.1.2):用于Base64解码。
x”,选择需要导入的Apifox文件。 在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目
Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块,不能单独使用类库里的某个子模块,具体看本文档末尾说明。 atob(v2.1.2):用于Base64解码。
x”,选择需要导入的Apifox文件。 在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目
在Chrome浏览器设置页面单击左下角“扩展程序”。 进入扩展程序页面后,打开右上角“开发者模式”。 单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。 父主题: 访问CodeArts API服务
s TestPlan的计费规则。 用户开通“CodeArts体验版”后,支持免费试用“API测试”的相关特性,具体以CodeArts TestPlan的试用公告为准。 功能涉及到使用华为云的相关资源,例如API发布,需要预先购买APIG实例,则需要支付相应的资源使用费用,具体购买操作请参照插件管理。
说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介 API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方