检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”，默认进入“第三方推送”页签。 单击“新建”，弹出“新增同步任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称，只允许输入字母、汉字、数
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
接口审核 审核设置 提交审核 接口审核 父主题： API设计
示例一：该示例引入加密算法模块 crypto-js，并使用其中 AES 对 message 进行加解密 * @param message 需要加密的文本 * @param key 秘钥 */ function cryptoJSTest(message, key) { const
示例一：该示例引入加密算法模块 crypto-js，并使用其中 AES 对 message 进行加解密 * @param message 需要加密的文本 * @param key 秘钥 */ function cryptoJSTest(message, key) { const
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题： 导入与导出
导入/导出接口 导入接口 定时导入接口 导出接口 父主题： 导入与导出
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。 其
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。
示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口，如“查询产品列表”。 默认进入“文档”页签，可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面，详细操作可参照API设计章节。 单击“调试”页签进入调试页面，详细操作可参照示例接口调试。 示例接口调试 打开“MockURL”开关。
在“导入项目”对话框上输入项目名称，单击“确定”。 弹出“导入预览”对话框，选择“接口”或“数据模型”，可预览所有导入数据，然后单击“导入”。 弹出导入进度对话框，可查看导入进度。 导入完成后，可进入导入项目，查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
在“导入项目”对话框上输入项目名称，单击“确定”。 弹出“导入预览”对话框，选择“接口”或“数据模型”，可预览所有导入数据，然后单击“导入”。 弹出导入进度对话框，可查看导入进度。 导入完成后，可进入导入项目，查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入
Y Y Y 修改 修改测试版本 Y Y N Y N Y Y N N N N 删除 删除测试版本 Y Y N Y N Y Y N N N N 接口测试-关键字 创建 创建关键字 Y Y Y Y N Y Y Y Y N N 查看 查看关键字 Y Y Y Y Y Y Y Y Y Y Y 编辑
Y Y Y 修改 修改测试版本 Y Y N Y N Y Y N N N N 删除 删除测试版本 Y Y N Y N Y Y N N N N 接口测试-关键字 创建 创建关键字 Y Y Y Y N Y Y Y Y N N 查看 查看关键字 Y Y Y Y Y Y Y Y Y Y Y 编辑
完成创建API设计规范后，单击“启用”，可正式使用设计规范。 无需检查接口 支持添加无需检查接口。 在“无需检查的接口”页签，单击“添加API接口”，弹出“添加不需要检查的接口”对话框。 选择无需检查接口，单击“确定”，完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
