检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用场景 CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
应用场景 CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
了解更多常见问题、案例和解决方案 热门案例 IAM账号进入CodeArts API首页报错 当前套餐人数不够用怎么办? 快捷调试的接口代码怎么获取? 智能客服 您好!我是有问必答知识渊博的智能问答机器人,有问题欢迎随时求助哦! 社区求助 华为云社区是华为云用户的聚集地。这里有来自各服务的技术牛人,为您解决技术难题。
响应头。 数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。
根据输入的Json自动生成数据结构功能。 接口返回响应 返回响应的定义包含:返回响应的状态码、响应内容的数据结构、响应示例和响应头。 返回响应的状态码:通过加号来添加运行接口后可能的响应状态码,单击响应状态码可以对状态码进行修改。 响应内容的数据结构:规定响应内容的格式,分为“
TTPS、GRPCS时生效,关于AppCode获取方式请参照生成AppCode。 导入时间间隔 选择导入时间间隔: 按小时:1~24小时。 按天:1~100天。 导入版本 选择需要导入的API版本。 根目录 选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。
目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入 导出数据 打开YApi对应项目,单击“数据管理”,进入“数据管理”页面。 在导出数据模块中,选择“json”数据方式,单击导出,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。 弹出“导
响应头。 数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。
Collection数据文件的导入 弹出“导入”对话框,选择需要导入的接口,单击“导入”完成数据迁移。 Collections和Environments数据集ZIP包的导入 弹出“导入”对话框,选择需要导入的接口和环境变量,单击“导入”完成数据迁移。 导入通过Postman导出的文件时,接
根据输入的Json自动生成数据结构功能。 接口返回响应 返回响应的定义包含:返回响应的状态码、响应内容的数据结构、响应示例和响应头。 返回响应的状态码:通过加号来添加运行接口后可能的响应状态码,单击响应状态码可以对状态码进行修改。 响应内容的数据结构:规定响应内容的格式,分为“
目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入 导出数据 打开YApi对应项目,单击“数据管理”,进入“数据管理”页面。 在导出数据模块中,选择“json”数据方式,单击导出,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。 弹出“导
TTPS、GRPCS时生效,关于AppCode获取方式请参照生成AppCode。 导入时间间隔 选择导入时间间隔: 按小时:1~24小时。 按天:1~100天。 导入版本 选择需要导入的API版本。 根目录 选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
Collection数据文件的导入 弹出“导入”对话框,选择需要导入的接口,单击“导入”完成数据迁移。 Collections和Environments数据集ZIP包的导入 弹出“导入”对话框,选择需要导入的接口和环境变量,单击“导入”完成数据迁移。 导入通过Postman导出的文件时,接
tman存量数据,具体导入操作可参照导入接口,支持导入的数据格式为: Collections和Environment数据集ZIP包 单个Collection文件 兼容Postman脚本语法,可以在CodeArts API中直接运行Postman脚本。 Postman中Run co
内置参数是将HTTP/HTTPS响应的对应部分参数化,在检查点、响应提取功能中的“来源”选项中可以选择内置参数。 内置参数如下表: 内置参数 参数说明 是否支持多级取值 用途 举例 响应体(json) 表示接口返回的响应体。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应体中的id等于100。
准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
内置参数是将HTTP/HTTPS响应的对应部分参数化,在检查点、响应提取功能中的“来源”选项中可以选择内置参数。 内置参数如下表: 内置参数 参数说明 是否支持多级取值 用途 举例 响应体(json) 表示接口返回的响应体。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应体中的id等于100。