检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
访问CodeArts API服务 浏览器访问 客户端访问 父主题: 使用CodeArts API服务
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。
API中心发布 介绍如何将已开发好的API分享至API中心。 前提条件 已完成服务商入驻。 操作步骤 单击项目名称,进入目标项目详情页面,单击“API发布 > API中心发布”。 单击“申请发布”,跳转至“创建API资产”页面。 选择导入API、填写API资产信息,参数说明请分别参见表1、表2。
API研发流程体系难以管控,缺少API全生命周期规范。 API一致性差,维护不同工具之间数据一致性非常困难、低效。 API开发流程自动化程度低。 华为云CodeArts API是API全生命周期一站式管理平台,为API设计者、开发者、管理者提供一站式解决方案,能够有效的解决上述问题。
API研发流程体系难以管控,缺少API全生命周期规范。 API一致性差,维护不同工具之间数据一致性非常困难、低效。 API开发流程自动化程度低。 华为云CodeArts API是API全生命周期一站式管理平台,为API设计者、开发者、管理者提供一站式解决方案,能够有效的解决上述问题。
API设计”的接口数据。 单击“导入”,完成测试步骤添加。 自定义请求 在测试用例中,可能需要调用项目之外的接口,例如在请求华为终端app前,需要调用账号服务的获取用户认证token。此时用户可以在测试步骤中添加自定义请求,自定义请求可以是任何 HTTP 请求,包括常见的 GET、POST、PUT、DELETE
API设计”的接口数据。 单击“导入”,完成测试步骤添加。 自定义请求 在测试用例中,可能需要调用项目之外的接口,例如在请求华为终端app前,需要调用账号服务的获取用户认证token。此时用户可以在测试步骤中添加自定义请求,自定义请求可以是任何 HTTP 请求,包括常见的 GET、POST、PUT、DELETE
增加公共组件编辑功能,不可视字符进行高亮提示,API测试增加默认变量MockURL。 2023-11-30 - 2.0.1 Windows X86 新特性: 增加扫码登录记住账号密码功能,新增快捷键能力,Postman文件可导入快捷调试,公共模型与快捷调试目录支持文件拖拽等功能。 2024-01-09 单击下载
什么是CodeArts API CodeArts API是华为云API全生命周期管理一体化解决方案平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API各阶段数据高度一
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成
支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts
API服务,限制人数50人。 “API测试”的“测试用例”与“测试套件”,集成了CodeArts TestPlan的“接口自动化测试”与“测试执行”两个特性,均需要在华为云执行机上执行,因此属于付费特性,用户需要开通CodeArts的付费套餐或CodeArts TestPlan套餐后方可使用,具体请参照CodeArts
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述。 单击“确定”。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。