检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者“购买ROM
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
的账号,选择邀请方式并输入对应ID,单击“确定”。 用户ID:被邀请用户的ID,通过“我的凭证 ”获取“IAM用户ID”。获取方式请参考API凭证。 委托ID:被邀请账号中已创建的委托ID,通过IAM服务中的“委托”页面获取。 单击“确定”,可以将其他企业用户添加到项目中。 从委托中导入用户
响应提取 响应提取是提取接口响应结果的某一部分,命名为参数,供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
的账号,选择邀请方式并输入对应ID,单击“确定”。 用户ID:被邀请用户的ID,通过“我的凭证 ”获取“IAM用户ID”。获取方式请参考API凭证。 委托ID:被邀请账号中已创建的委托ID,通过IAM服务中的“委托”页面获取。 单击“确定”,可以将其他企业用户添加到项目中。 从委托中导入用户
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 约束与限制 克隆成项目时,只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。
测试人员 参与者 浏览者 注册APIG 创建 注册API Y Y N N Y N N N N N N 查看 查看注册API Y Y Y Y Y Y Y Y Y Y Y 编辑 重新注册API Y Y N N Y N N N N N N 删除 删除注册API Y Y N N Y N N
因存量版本未在API测试模块中创建,在API测试模块中切换版本时会弹出是否新建版本的提示窗口,请根据需要进行创建。 克隆成项目 CodeArts API同一项目不同版本支持单独克隆为新项目。 目前只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块
一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。
权限相关 IAM账号进入CodeArts API首页报错
功能相关 快捷调试的接口代码怎么获取? CodeArts API是否支持离线使用? 如何从Postman无缝迁移到CodeArts API? CodeArt API的客户端与Web端差异
导入与导出 导入项目 导入快捷调试 导入/导出接口
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
套餐相关 当前套餐人数不够用怎么办?
导入与导出 导入项目 导入快捷调试 导入/导出接口
应用场景 CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
客户端新增未登录使用快捷调试能力;API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入;API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性: 项目管理模块新增导入Apifox项目能力;API测试模块新增关键字库
客户端1.0.0版本正式发布,提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22 - 2.0.0 Windows X86 新特性: 增加公共组件编辑功能,不可视字符进行高亮提示,API测试增加默认变量MockURL。