检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关闭审核功能后,在项目下API设计中创建、删除、修改API的操作
单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。 父主题: API Mock
CodeArt API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
访问客户端 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未
公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体,默认请求类型为“application/json”。 支持设计Body体引用,并且在公共请求体的文档页面支持查看引用当前公共请求体的API。 公共示例 接口的公共示例,可在API设计请求体示例与返回响应的响应示
客户端访问 下载CodeArts API客户端 访问客户端 全局代理 父主题: 访问CodeArts API服务
一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock
全局代理 CodeArts API客户端版本支持设置全局网络代理,设置后,代理应用于所有联网服务,包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后,单击右上角,进入设置页面。 单击“网络代理”,进入网络代理设置页面,可根据需要选择代理模
后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm.response.to.have pm.test('Response
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
全局代理 CodeArts API客户端版本支持设置全局网络代理,设置后,代理应用于所有联网服务,包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后,单击右上角,进入设置页面。 单击“网络代理”,进入网络代理设置页面,可根据需要选择代理模
以快速构造异常场景,提升测试覆盖率。 前后端分离开发:前端开发往往依赖于后端数据接口,在后端接口就绪之前,前端往往很难推进,前端可以通过Mock功能制造场景数据接口来进行开发与调试。 父主题: API Mock
页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。 接口级高级Mock页面 单击“API设计”,选择对应的接口。 单
费使用的升级版套餐。 需要升级套餐的用户,需先退订再购买,退订不影响原有资源。但是需要注意,新版免费套餐限制试用API测试能力,可以通过免费开启高阶功能试用,体验API测试的高阶能力,具体套餐详情请参照CodeArts套餐概述。 操作步骤 打开云服务退订页面,单击“退订资源”,退订当前的CodeArts套餐。
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题: API设计