检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
内置参数是将HTTP/HTTPS响应的对应部分参数化,在检查点、响应提取功能中的“来源”选项中可以选择内置参数。 内置参数如下表: 内置参数 参数说明 是否支持多级取值 用途 举例 响应体(json) 表示接口返回的响应体。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应体中的id等于100。
API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。 内置Mock代理,M
API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业API规范性自动化检查,设计问题辅助修复。 文档、设计、调试自动同步,API数据同源高效协同。 内置Mock代理,M
拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。
拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。
单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 单击角色列表右侧的,弹出“创建角色”窗口。 在弹框中设置以下信息,单击“确定”。 表1 表1 创建角色 配置项 是否必填 说明 角色名称 是 不能与系统角色、已创建自定义角色名称重复。 支持
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 单击角色列表右侧的,弹出“创建角色”窗口。 在弹框中设置以下信息,单击“确定”。 表1 表1 创建角色 配置项 是否必填 说明 角色名称 是 不能与系统角色、已创建自定义角色名称重复。 支持
=,支持类型:数字、字符。 表达式(选择表达式后输入“@”符开启选择)。 存在、不存在:判断Query、Header名称是否存在。 包含、不包含:判断Query、Header、Path中的某个字段的值是否包含某个值。 正则:判断Query、Header、Path中的某个字段的值是否符合正则表达式中的匹配规则。
=,支持类型:数字、字符。 表达式(选择表达式后输入“@”符开启选择)。 存在、不存在:判断Query、Header名称是否存在。 包含、不包含:判断Query、Header、Path中的某个字段的值是否包含某个值。 正则:判断Query、Header、Path中的某个字段的值是否符合正则表达式中的匹配规则。
选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。
成员被移出后,其名下的工作项等资源不会被删除,用户操作记录仍旧会被保留。 批量移出项目成员 在“成员”页面的项目成员列表中勾选目标成员。 单击“移除成员”。 根据提示单击“确定”,即可完成项目成员批量移出。 退出项目成员 在“成员”列表页面中单击自己所在行后的,可以主动退出项目。 退出项目只对本人可见。 用户被添加为
成员被移出后,其名下的工作项等资源不会被删除,用户操作记录仍旧会被保留。 批量移出项目成员 在“成员”页面的项目成员列表中勾选目标成员。 单击“移除成员”。 根据提示单击“确定”,即可完成项目成员批量移出。 退出项目成员 在“成员”列表页面中单击自己所在行后的,可以主动退出项目。 退出项目只对本人可见。 用户仅可以退出非自己创建项目。
使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,操作可参照API设计章节。 单击“调试”页
版本号 操作系统 OS支持 更新内容 发布时间 下载链接 1.0.0 Windows X86 新特性: 客户端1.0.0版本正式发布,提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22 - 2.0.0 Windows
路径前,提示此前置URL来自于哪一环境,单击环境名称,可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。
路径前,提示此前置URL来自于哪一环境,单击环境名称,可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。
则:只支持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编