检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。API
CodeArts API是否支持离线使用? CodeArts API客户端支持离线使用,在登录客户端时,单击“稍后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步
IAM账号进入CodeArts API首页报错 IAM账号首次进入CodeArts API首页报错,需要给IAM账号进行授权。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用
如何从Postman无缝迁移到CodeArts API? 可以在API设计页面,通过单击搜索栏旁边,选择“导入Postman文件”来导入Postman存量数据,具体导入操作可参照导入接口,支持导入的数据格式为: Collections和Environment数据集ZIP包 单个Collection
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可以编辑
背景介绍 随着微服务系统及分布式架构的发展,多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时,依赖的第三方服务不能返回想要的结果,或第三方服务不稳定时,该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题,使用场景如下: 并行开发:在被依赖模块未开发完成时
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
背景介绍 随着微服务系统及分布式架构的发展,多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时,依赖的第三方服务不能返回想要的结果,或第三方服务不稳定时,该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题,使用场景如下: 并行开发:在被依赖模块未开发完成时
Markdown设计 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。 方法二:在目录树中选择一个目录,单击右侧图标,在弹出的下拉框中,选择“新建Markdown”。 进入“新建标签页”,在该标签页可以编辑
接口审核 审核设置 提交审核 接口审核 父主题: API设计
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock