检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题: API设计
API设计 项目概况 API设计 接口审核 编辑模式与API规范检查 公共模型 Markdown设计 API调试 脚本能力
API Mock 背景介绍 Mock规则管理 Mock规则设计 Mock语法说明 设置Mock
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题: 导入与导出
导入与导出 导入项目 导入快捷调试 导入/导出接口
接口审核 审核设置 提交审核 接口审核 父主题: API设计
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
式,如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块,不能单独使用类库里的某个子模块,具体看本文档末尾说明。 atob(v2.1.2):用于Base64解码。 btoa(v1.2.1):用于Base64编码。 tv4(v1.3.0):用于校验JSONSchema。
使用方法。 使用API设计 示例项目中已经预设了不同请求的API示例和公共模型。单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,详细操作可参照API设计章节。 单击“调试”页签进入调试页面,详细操作可参照示例接口调试。
API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代
完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。 弹出“导入项目”对话框,默认导入文件格式为“Apifox”,选择需要导入的Apifox文件。 在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。
完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。 弹出“导入项目”对话框,默认导入文件格式为“Apifox”,选择需要导入的Apifox文件。 在“导入项目”对话框上输入项目名称,单击“确定”。 弹出“导入预览”对话框,选择“接口”或“数据模型”,可预览所有导入数据,然后单击“导入”。
单击项目名称,进入目标项目后,单击“自动选择 >下载”。 下载后解压文件到文件夹中。 在Chrome浏览器设置页面单击左下角“扩展程序”。 进入扩展程序页面后,打开右上角“开发者模式”。 单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。
在接口的快捷调试页面单击,选择“保存为接口”。 在“保存为接口”页面输入接口名称,选择接口目录,单击“确定”,保存接口。 单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。
测试套件管理 创建测试套件 运行&报告 父主题: API测试
接口审核 审核设置 提交审核 接口审核 父主题: API设计
导入/导出接口 导入接口 定时导入接口 导出接口 父主题: 导入与导出