检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
目录:在上一步中,如果通过方法一和方法二新建Markdown,目录初始内容为空,可以手动选择;如果通过方法三新建Markdown,目录会自动生成为选中的目录,也可以手动修改。 名称:可根据业务需要自定义命名,不能为空。命名规则:只支持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。
数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应
前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 环境参数入口 进入目标项目后,
数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应
前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。 前提条件 免费开通“API测试”的高阶功能试用或开通CodeArts
打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。 操作变量 可以通过脚本对环境变量和临时变量进行特定操作,此类操作可以通过代码片段直接引入。 发送请求 可以通过脚本发送https请求,此操作可以通过代码片段直接引入。 编写并执行JS函数
打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。 操作变量 可以通过脚本对环境变量和临时变量进行特定操作,此类操作可以通过代码片段直接引入。 发送请求 可以通过脚本发送https请求,此操作可以通过代码片段直接引入。 编写并执行JS函数
项目创建完成后,需要配置项目成员及成员角色。 前提条件 对项目具有管理权限。 项目管理员才可以添加成员或将成员移出项目。 项目创建者可以删除项目经理和测试经理。 项目经理可以删除测试经理。 操作入口 单击项目名称,进入目标项目,单击“项目设置 > 成员管理”,进入“成员管理”页面。 添加本企业用户
准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。
字驱动测试可用于组件测试、系统测试等不同级别的测试,其优势体现在易用性、可理解性、可维护性、测试信息的重用、支持测试自动化、节约潜在的成本和进度等方面。在设计测试用例时,经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤,重复工作量很大,并且难以维护。测试关键字可以帮助复用这些测试步骤。
字驱动测试可用于组件测试、系统测试等不同级别的测试,其优势体现在易用性、可理解性、可维护性、测试信息的重用、支持测试自动化、节约潜在的成本和进度等方面。在设计测试用例时,经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤,重复工作量很大,并且难以维护。测试关键字可以帮助复用这些测试步骤。
API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。
API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。
定义接口的请求方式,制定了客户端对服务端资源操作的方法,在API设计过程中,需要根据业务和操作类型选择合适的请求方式。 GET(获取):用于获取指定资源,使用查询参数传递参数,适用于读取资源和查询数据。 POST(提交):用于提交数据。POST请求可以传递请求体参数,适用创建新资源、提交表单数据或执行某些操作等场景。
可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded:Content-Type为“application/x-www-form-urlencoded”,可以输入请求体中每个参数的名称和值。 raw:在文本框中输入文本内容,
可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded:Content-Type为“application/x-www-form-urlencoded”,可以输入请求体中每个参数的名称和值。 raw:在文本框中输入文本内容,