检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口审核 审核设置 提交审核 接口审核 父主题: API设计
使用CodeArts API服务 访问CodeArts API服务 授权使用CodeArts API 创建、管理项目 管理项目成员与角色权限
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题: 导入与导出
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题: API设计
访问客户端 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用
背景介绍 随着微服务系统及分布式架构的发展,多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时,依赖的第三方服务不能返回想要的结果,或第三方服务不稳定时,该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题,使用场景如下: 并行开发:在被依赖
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可
API支持Postman的Collection数据文件的导入,也支持Collections和Environments数据集ZIP包的全量导入,方便用户迁移调试数据。 进入“快捷调试”页面,单击,选择“导入Postman文件”。 弹出“导入Postman文件”对话框,选择需要导入的Postman文件。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。
测试套件管理 创建测试套件 运行&报告 父主题: API测试
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出
测试套件管理 创建测试套件 运行&报告 父主题: API测试
对参数的简要描述,上限为3000字符。默认为当前参数类型的描述。 单击“文本框”后,用户可以直接输入文本描述。 单击,输入一个json,单击“Json转换”,可以给没有换行的Json添加换行和缩进,单击“回填”添加成功。 值 否 用户可以为不同类型的参数赋值。 敏感变量 否 勾选为敏感数据后,测试计
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。