检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Arts API提供以下7种公共模型定义:数据模型、公共响应、公共参数、公共请求体、公共示例、安全模型、公共响应头。 数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。
如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法 类型 函数 Basic boolean、natural、integer、float、character、string、range、date、t
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
些表单数据、JSON数据或者二进制数据。在发送请求时,会根据Body参数类型,自动在请求Header中添加对应Content-Type参数。若手工设置Content-Type的类型,则必须与Body的参数类型匹配,否则系统会自动忽略掉手动设置的Content-Type值。 none:无body参数。
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数、公共请求体、公共示例、安全模型、公共响应头。 数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。
在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者“购买ROMA实例”,根据界面提示购
成长地图 | 华为云 CodeArts API CodeArts API是面向开发者,提供API设计、API开发、API文档、API调试、 API自动化测试一体化协作平台,通过维护API各开发阶段数据高度一致,支持开发者高效实现API设计、API开发、API测试一站式体验。 产品介绍
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
PI。 选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道
功能涉及到使用华为云的相关资源,例如API发布,需要预先购买APIG实例,则需要支付相应的资源使用费用,具体购买操作请参照插件管理。 购买CodeArts TestPlan套餐后,项目中添加成员时会根据已购买服务的套餐人数自动分配服务访问权限,直到达到套餐人数规格。用户可以随时在CodeArts API首页单击“用户头像>
PI。 选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道
API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型:接口类型默认HTTP和HTTPS全选,支持两种协议类型的代理。 代理服务器:需输入代理服务器地址和端口。 身份认证:请查看身份认证。
在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者“购买ROMA实例”,根据界面提示购
支持json。函数需要写在vaule值位置,以“@”作为起始符。 支持xml。(本版本不支持,下个版本支持。) 不支持单独@函数。 只支持在响应体内使用mock.js。 实例如下: 输入 示例结果 { "id":@uuid(), "flag":@boolean(1, 9, true), "name"
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结构为Json格式时,支持JsonSchema和Json标准(双斜杠类型字段注释将被识别为字段描述)格式导入。 父主题: 导入与导出
详细介绍请参见示例:根据JsonPath从响应体中获取数据。 高级提取类型 可选项,使用高级提取类型,辅助提取响应结果信息,若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式: 字符串提取,也就是字符串的截取。 正则表达式,即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能,若不能满足需求可考虑使用正则表达式。
3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL 第三方URL地址。 Auth 推送URL的认证类型。 No Auth:表示无认证。 API Key:使用 API Key 进行身份验证。 Bearer Token:用于身份验证的访问令牌,