检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。
>下载”。 下载后解压文件到文件夹中。 在Chrome浏览器设置页面单击左下角“扩展程序”。 进入扩展程序页面后,打开右上角“开发者模式”。 单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。 父主题:
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
>下载”。 下载后解压文件到文件夹中。 在Chrome浏览器设置页面单击左下角“扩展程序”。 进入扩展程序页面后,打开右上角“开发者模式”。 单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。 约束与限制
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。API
环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。 Mock选项 打开URL输入框右侧的MockURL按钮,开
摘要:接口的摘要信息。 状态:API生命周期的状态,包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录:接口在项目中所属的目录。 所属Tags:接口所属的Tags,可以直接选择所属目录信息当作所属Tags,也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。
API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型:接口类型默认HTTP和HTTPS全选,支持两种协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。
餐限制试用API测试能力,可以通过免费开启高阶功能试用,体验API测试的高阶能力,具体套餐详情请参照CodeArts套餐概述。 操作步骤 打开云服务退订页面,单击“退订资源”,退订当前的CodeArts套餐。 进入购买CodeArts套餐页面,根据需要选择区域、版本、购买人数、购
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。API
入范围,可选择“全部”或者“选择快捷调试”。 导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示
首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。
环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中,对Query参数进行修改,路径中的Query参数也会同步变化。 Mock选项 打开URL输入框右侧的MockURL按钮,开
管理员登录IAM控制台。 单击“用户组”,进入用户组页面。 “在用户组列表中,单击用户组操作的“授权”,进入用户组权限设置页面。如未创建用户组,可单击“创建用户组”,创建新的用户组,详细步骤请参照创建用户组章节。 在用户组选择策略页面中,勾选“DevCloud Console ReadOnlyAccess”权限。单击“下一步”。
管理员登录IAM控制台。 单击“用户组”,进入用户组页面。 “在用户组列表中,单击用户组操作的“授权”,进入用户组权限设置页面。如未创建用户组,可单击“创建用户组”,创建新的用户组,详细步骤请参照创建用户组章节。 在用户组选择策略页面中,勾选“DevCloud Console ReadOnlyAccess”权限。单击“下一步”。
API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型:接口类型默认HTTP和HTTPS全选,支持两种协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。
摘要:接口的摘要信息。 状态:API生命周期的状态,包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录:接口在项目中所属的目录。 所属Tags:接口所属的Tags,可以直接选择所属目录信息当作所属Tags,也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描
单击“调试”页签进入调试页面,详细操作可参照示例接口调试。 示例接口调试 打开“MockURL”开关。 确认云端MockURL,详细Mock规则查询请参照高级Mock。 单击“发送”。 在响应体中查看响应。 高级Mock CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。
单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenAPI 3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL