检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API
册。 一个API可发布到同一个APIG的不同API分组。 注册API后需要到APIG实例中完成发布API操作,才可完成API的上线。 API重新注册 CodeArts API提供API重新注册的功能,协助用户将已修改或不同版本的API重新注册到APIG实例。 在“API网关注册”
授权使用CodeArts API 支持授权IAM账号和企业联邦账号使用CodeArts API。 约束与限制 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
访问CodeArts API服务 浏览器访问 客户端访问 父主题: 使用CodeArts API服务
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
使用CodeArts API服务 访问CodeArts API服务 授权使用CodeArts API 创建、管理项目 管理项目成员与角色权限
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
访问CodeArts API服务 浏览器访问 客户端访问 父主题: 使用CodeArts API服务
deArts API资源。 根据企业用户的职能,设置不同的访问权限,实现权限隔离。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用CodeArts API产品,但不可创建项目。
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
使用CodeArts API服务 访问CodeArts API服务 授权使用CodeArts API 创建、管理项目 管理项目成员与角色权限
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP