检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型:接口类型默认HTTP和HTTPS全选,支持两种协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型:接口类型默认HTTP和HTTPS全选,支持两种协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。
PUT(更新):用于更新或替换服务端的指定资源。 DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获
PUT(更新):用于更新或替换服务端的指定资源。 DELETE(删除):用于删除服务端的指定资源。 OPTIONS(选项):用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程,了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
单击“生成代码”下拉框,选择“生成业务代码”,弹出“生成业务代码”对话框。 根据需要选择语言、生成范围(包括“仅当前接口及关联模型”和“整个项目”),单击“生成”将生成的代码存储到本地,开发者可以将代码复制到本地的研发工具(如IntelliJ IDEA)。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
API发布 API中心发布 API网关注册
Token:用于身份验证的访问令牌,授权持有者(Bearer)访问资源的权限。 Basic Auth: 基本认证,一种HTTP认证协议,用于在客户端和服务器之间进行身份验证。 Huawei IAM:华为云IAM认证,通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证。
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
单击“生成代码”下拉框,选择“生成业务代码”,弹出“生成业务代码”对话框。 根据需要选择语言、生成范围(包括“仅当前接口及关联模型”和“整个项目”),单击“生成”将生成的代码存储到本地,开发者可以将代码复制到本地的研发工具(如IntelliJ IDEA)。
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题: API设计
API Mock 背景介绍 Mock规则管理 Mock规则设计 Mock语法说明 设置Mock
功能相关 快捷调试的接口代码怎么获取? CodeArts API是否支持离线使用? 如何从Postman无缝迁移到CodeArts API? CodeArt API的客户端与Web端差异
API Mock 背景介绍 Mock规则管理 Mock规则设计 Mock语法说明 设置Mock
权限相关 IAM账号进入CodeArts API首页报错