检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作将立即生
可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签,单击“添加API接口”,弹出“添加不需要检查的接口”对话框。 选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。
可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签,单击“添加API接口”,弹出“添加不需要检查的接口”对话框。 选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。
设计。 前置脚本、后置脚本操作请查看脚本能力章节。 导入Postman文件 单击“导入Postman文件”,弹出“导入Postman文件”对话框。 上传需要导入的Postman文件,选择导入范围,可选择“全部”或者“选择快捷调试”。 导入通过Postman导出的文件时,接口示例会
"Karen Lisa Harris" @name(false) "Karen Harris" 中文姓 @cfirst @cfirst() "张" 中文名 @clast() @clast() "三" 中文姓名 @cname @cname() "张三" Address相关 分类 规则 示例 示例结果
果通过方法三新建Markdown,目录会自动生成为选中的目录,也可以手动修改。 名称:可根据业务需要自定义命名,不能为空。命名规则:只支持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、
"Karen Lisa Harris" @name(false) "Karen Harris" 中文姓 @cfirst @cfirst() "张" 中文名 @clast() @clast() "三" 中文姓名 @cname @cname() "张三" Address相关 分类 规则 示例 示例结果
果通过方法三新建Markdown,目录会自动生成为选中的目录,也可以手动修改。 名称:可根据业务需要自定义命名,不能为空。命名规则:只支持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、
p”,则可以使用“${hostIp}”来引用该参数。 局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。 类型 是 支持文本、随机字符串、随机整数、时间戳、格式化时间戳、生成UUID、Bas
p”,则可以使用“${hostIp}”来引用该参数。 局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。 类型 是 支持文本、随机字符串、随机整数、时间戳、格式化时间戳、生成UUID、Bas
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
设置Mock 默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认
设置Mock 默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题: