检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
择下拉选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
择下拉选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
约束与限制 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
开启Mock服务,接口路径的域名会变成云端Mock地址。Mock服务具体功能请请参考API Mock。 请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。
开启Mock服务,接口路径的域名会变成云端Mock地址。Mock服务具体功能请请参考API Mock。 请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题: 导入与导出
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出
在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
数的值,那么可以在后置操作中输入如下自定义脚本: var test = pm.response.headers.get("date"); console.log(test); 对于断言的处理 pm.test pm.test(testName:String, specFunctio
完成创建API设计规范后,单击“启用”,可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签,单击“添加API接口”,弹出“添加不需要检查的接口”对话框。 选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。
数的值,那么可以在后置操作中输入如下自定义脚本: var test = pm.response.headers.get("date"); console.log(test); 对于断言的处理 pm.test pm.test(testName:String, specFunctio