检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
浏览器访问 访问CodeArts API产品官网首页，单击“网页版体验”，填写华为云账户密码进行登录，进入CodeArts API首页。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
API不使用任何代理（包含系统代理）连接服务器。 自定义 选择自定义代理时，需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型：接口类型默认HTTP和HTTPS全选，支持两种协议类型的代理。 代理服务器：需输入代理服务器地址和端口。 身份认证：请查看身份认证。
API不使用任何代理（包含系统代理）连接服务器。 自定义 选择自定义代理时，需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型：接口类型默认HTTP和HTTPS全选，支持两种协议类型的代理。 代理服务器：需输入代理服务器地址和端口。 身份认证：请查看身份认证。
浏览器访问 访问CodeArts API产品官网首页，单击“网页版体验”，填写华为云账户密码进行登录，进入CodeArts API首页。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
单击“项目设置 > 导出数据”，默认进入“第三方推送”页签。 单击“新建”，弹出“新增同步任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。 数据源格式 支持OpenAPI 3.0、Swagger
套餐相关 当前套餐人数不够用怎么办？
单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。 数据源格式 支持OpenApi格式。 数据源URL
选中需要发布的API，单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例，并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合，创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。 选择“使用”时，需要
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
PUT（更新）：用于更新或替换服务端的指定资源。 DELETE（删除）：用于删除服务端的指定资源。 OPTIONS（选项）：用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程，了解服务器所支持的方法和功能。 HEAD（请求头）：与GET类似，但只返回响应头部，不返回实体内容，用于获
单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。 数据源格式 支持OpenApi格式。 数据源URL
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
PUT（更新）：用于更新或替换服务端的指定资源。 DELETE（删除）：用于删除服务端的指定资源。 OPTIONS（选项）：用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程，了解服务器所支持的方法和功能。 HEAD（请求头）：与GET类似，但只返回响应头部，不返回实体内容，用于获
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下： 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下： 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
选中需要发布的API，单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例，并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合，创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。 选择“使用”时，需要
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题： 使用CodeArts API服务
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API，并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档，支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
