检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
脚本能力 执行流程 前置脚本 后置脚本 pm对象API参考 使用JS类库 父主题: API设计
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下: 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下: 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API
执行流程 CodeArts API提供基于JavaScript的脚本引入,通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前执行的脚本类型
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如
执行流程 CodeArts API提供基于JavaScript的脚本引入,通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前执行的脚本类型
约束与限制 克隆成项目时,只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。 测试用例导入时,因存量版本未在API测试模块中被同步创建,不可导入API测试未存在版本的测试用例。
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。
架构师在Swagger中设计API文档后,后端工程师需要根据设计文档实现代码,如果设计修改则需要手工实现代码同步。 后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。
架构师在Swagger中设计API文档后,后端工程师需要根据设计文档实现代码,如果设计修改则需要手工实现代码同步。 后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。