检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
功能相关 快捷调试的接口代码怎么获取? CodeArts API是否支持离线使用? 如何从Postman无缝迁移到CodeArts API? CodeArt API的客户端与Web端差异
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
功能总览 功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化
功能总览 功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化
eArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。 父主题: 功能相关
单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。 父主题: 功能相关
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。
项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。
一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 切换登录状态
一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 切换登录状态
在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 前提条件 免费开通“API测试”的高阶功能试用或开通CodeArts
在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 前提条件 免费开通“API测试”的高阶功能试用或开通CodeArts
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页
默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页
用户开通“CodeArts体验版”后,支持免费试用“API测试”的相关特性,具体以CodeArts TestPlan的试用公告为准。 功能涉及到使用华为云的相关资源,例如API发布,需要预先购买APIG实例,则需要支付相应的资源使用费用,具体购买操作请参照插件管理。 购买CodeArts