检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
环境与环境变量 在开发项目中,不同阶段对应不同环境,例如:前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。
数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。 新建快捷调试 单
导入文件 选择响应格式的文件并上传,然后选择文件中系统识别出来的接口和数据模型导入。 Postman支持Collections和Environment数据集ZIP包的全量导入,也支持单个Collection文件导入。 Postman支持接口和接口用例的前置脚本及后置脚本导入。 导入URL
毁阶段。 准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
毁阶段。 准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
API提供同项目内两个不同版本的API对比功能。 在“版本管理”页面,选择需要对比的两个版本,单击“版本API接口对比”,可对比不同版本的具体内容和变更细节。 接口导出 CodeArts API提供不同版本接口的导出功能。 在“版本管理”页面,单击目标版本所在行的,选择“导出”。 选择文
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API S
目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API S
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。
API设计&快捷调试模块接口和模型的目录命名支持数字开头。 2024-12-04 2.1.1 Windows X86 修复: 1、修复部分已知问题。 2024-10-21 2.1.0 Windows X86 新特性: 项目支持分组功能、支持显示IPD类型的项目;新增系统公告能力,包
单击目标版本所在行的,弹出“克隆成项目”对话框。 输入需要克隆成项目版本的项目名称与项目描述,单击“确定”。 版本对比 CodeArts API提供同项目内两个不同版本的API对比功能。 在“版本管理”页面,选择需要对比的两个版本,单击“版本API接口对比”,可对比不同版本的具体内容和变更细节。
能力。API全生命周期管理也是DevOps实践的一个关键组成部分,通过提供标准化、自动化的API创建、测试、部署和管理流程,支持DevOps中的快速迭代、高质量软件交付和持续改进的目标。了解更多软件开发生产线相关信息,请前往查看更多相关介绍。
YApi”,选择需要导入的YApi文件。 在“导入项目”对话框输入项目名称,单击“确定”。 弹出“导入预览”对话框,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结构为Json格式时
YApi”,选择需要导入的YApi文件。 在“导入项目”对话框输入项目名称,单击“确定”。 弹出“导入预览”对话框,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结构为Json格式时
其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。 填写“变更原因”,单击“提交”,提交API接口进入审核流程。 审核流程结束前,该提交审核的API接口将处于锁定状态,不可编辑和删除。 撤回审核
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。