检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
因存量版本未在API测试模块中创建,在API测试模块中切换版本时会弹出是否新建版本的提示窗口,请根据需要进行创建。 克隆成项目 CodeArts API同一项目不同版本支持单独克隆为新项目。 目前只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块
在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。 从【接口】导入 在弹出的“从【接口】导入”对话框上,选择需要导入的接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。
在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。 从【接口】导入 在弹出的“从【接口】导入”对话框上,选择需要导入的接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。
使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目中
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
应用场景 CodeArts API面向开发者提供API全生命周期管理的最佳实践。 CodeArts API既可以帮助个人开发者一站式管理运营自己的API,摆脱工具、环境的束缚,快速实现API资产变现;也可以帮助企业规范化API流程,端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
认证类、数据库操作类、中间件类、协议类等实用关键字放置在“系统”页签中,详细操作请参考接口自动化用例关键字。 单击关键字库中“名称”下拉列表,可以按照“名称”、“描述”,搜索对应的关键字。 接口关键字 接口关键字中定义单个接口的请求,可以通过导入Swagger文件、保存自定义URL请求等方式生成。
认证类、数据库操作类、中间件类、协议类等实用关键字放置在“系统”页签中,详细操作请参考接口自动化用例关键字。 单击关键字库中“名称”下拉列表,可以按照“名称”、“描述”,搜索对应的关键字。 接口关键字 接口关键字中定义单个接口的请求,可以通过导入Swagger文件、保存自定义URL请求等方式生成。
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
客户端新增未登录使用快捷调试能力;API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入;API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性: 项目管理模块新增导入Apifox项目能力;API测试模块新增关键字库
全局代理 CodeArts API客户端版本支持设置全局网络代理,设置后,代理应用于所有联网服务,包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后,单击右上角,进入设置页面。 单击“网络代理”,进入网络代理设置页面,可根据需要选择代理模
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
导出接口 在接口目录或已设计好的接口功能目录中,可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件,且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧,选择“导出”。 在弹出的“导出”窗口中,选择需要导出的数据格式及接口,单击“导出”。 父主题:
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。 父主题: API Mock