检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件，方便数据迁移。 Swagger Postman（支持Collections和Environment数据集ZIP包） Jmeter Swagger URL 手动导入 通过主页面的“更多功能”选项或单击左上角
接口审核 审核设置 提交审核 接口审核 父主题： API设计
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
导入/导出接口 导入接口 定时导入接口 导出接口 父主题： 导入与导出
API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
接口审核 审核设置 提交审核 接口审核 父主题： API设计
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件，方便数据迁移。 Swagger Postman（支持Collections和Environment数据集ZIP包） Jmeter Swagger URL 约束与限制 导入文件时，一个文件导入后，将会视为一
单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。 填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。 对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操作。
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题： 导入与导出
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
3-64个字符。 数据源格式 支持OpenAPI 3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL 第三方URL地址。 Auth 推送URL的认证类型。 No Auth：表示无认证。 API Key：使用 API Key 进行身份验证。 Bearer
API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“
选项中的“新建API接口”，创建http类型接口。 设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： 名称：接口名称。 摘要：接口的摘要信息。 状态：API生命周期的状态
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
