检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
API”。 项目信息 CodeArts API项目名称和ID。 API接口 当导入方式为“CodeArts API”时,支持勾选部分接口导入,如果导入全部接口,则忽略此参数。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介
API”。 项目信息 CodeArts API项目名称和ID。 API接口 当导入方式为“CodeArts API”时,支持勾选部分接口导入,如果导入全部接口,则忽略此参数。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 图标 为API资产设置一个图标。 资产简介
支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API一键托管,保障API高安全、高可用、高并发调用。
支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API一键托管,保障API高安全、高可用、高并发调用。
接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态,包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录:接口在项目中所属的目录。
接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态,包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录:接口在项目中所属的目录。
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts
什么是CodeArts API CodeArts API是华为云API全生命周期管理一体化解决方案平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API各阶段数据高度一
固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。
固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。
<、<=、>、>=,支持类型:数字。 =、!=,支持类型:数字、字符。 表达式(选择表达式后输入“@”符开启选择)。 存在、不存在:判断Query、Header名称是否存在。 包含、不包含:判断Query、Header、Path中的某个字段的值是否包含某个值。 正则:判断Query、Header、Pa
<、<=、>、>=,支持类型:数字。 =、!=,支持类型:数字、字符。 表达式(选择表达式后输入“@”符开启选择)。 存在、不存在:判断Query、Header名称是否存在。 包含、不包含:判断Query、Header、Path中的某个字段的值是否包含某个值。 正则:判断Query、Header、Pa
PI设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。 在“版本管理”页面。 单击目标版本所在行的,弹出“克隆成项目”对话框。 输入需要克隆成项目版本的项目名称与项目描述,单击“确定”。 版本对比 CodeArts API提供同项目内两个不同版本的API对比功能。
PI设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。 在“版本管理”页面。 单击目标版本所在行的,弹出“克隆成项目”对话框。 输入需要克隆成项目版本的项目名称与项目描述,单击“确定”。 版本对比 CodeArts API提供同项目内两个不同版本的API对比功能。
创建成功,在“自定义角色”中显示新的角色名称。 对新创建的角色,可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。 修改成功后,页面中显示更新后的角色名称。 删除角色
创建成功,在“自定义角色”中显示新的角色名称。 对新创建的角色,可以完成以下操作。 表2 表2 管理自定义角色 操作 说明 编辑角色权限 操作方式与修改系统角色的权限相同。 修改角色名称 单击角色名称后的,选择“修改角色名称”。 输入修改后的角色名称,单击“确定”。 修改成功后,页面中显示更新后的角色名称。 删除角色
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景: