检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。
表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
选择文件在本地存储位置、设置文件名,保存到本地,解压后可查看导出的接口文件。 测试用例导入 CodeArts API提供不同版本测试用例的导入功能。 在“版本管理”页面,单击目标版本操作列的,选择“导入”。 弹出“从版本导入测试用例”对话框。
标签 为该API资产添加分类属性,方便在大量创建API资产后,快速过滤和查找。 填写完API资产信息后,单击“立即创建”。 等待系统解析API文件,API资产所在行“状态”列如果显示“已上架”,说明解析完成,此时,API资产已成功分享至API中心门户网站。 父主题: API发布
请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。
单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。
创建成功,在“自定义角色”中显示新的角色名称。 对新创建的角色,可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。
表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
在“保存为接口”页面输入接口名称,选择接口目录,单击“确定”,保存接口。 单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。
请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。
参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenApi格式。 数据源URL 数据源URL地址。 认证方式 选择认证方式: 无认证:表示不需要认证。
参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenAPI 3.0、Swagger 2.0格式。 数据源URL 支持YAML、JSON。 第三方URL 第三方URL地址。
设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。
快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计
创建成功,在“自定义角色”中显示新的角色名称。 对新创建的角色,可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。
参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenApi格式。 数据源URL 数据源URL地址。 认证方式 选择认证方式: 无认证:表示不需要认证。
局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。
快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计
局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。