# 将测试步骤保存为CodeArts TestPlan接口脚本关键字 #### 背景信息 接口关键字中定义单个接口的请求，可以通过导入Swagger文件、保存自定义URL请求等方式生成。 Swagger是一个定义、开发、调试RESTful等接口的工具，使用Swagger可以标准化地定义接口属性，便于互联互通。接口自动化支持导入Swagger 2.0\&3.0格式的接口描述文件、解析接口的定义描述、生成脚本模板，只需要按照模板输入接口参数就可以创建接口自动化用例。 通过导入接口Swagger描述文件可以生成脚本模板，一个脚本模板对应Swagger中的一个接口定义，基于脚本模板可以可视化编排测试用例。 脚本模板和Swagger接口描述中字段的对应关系如下： - swagger 2.0规范如下： | 脚本模板属性 | Swagger接口定义属性 | |:---|:---| | 名称 | 默认使用operationId，可在设置中配置使用summary。 | | 路径 | schema + :// + basePath + path。 | | 请求参数hostURL | host | | 其它请求参数 | parameters | - swagger 3.0规范如下： | 脚本模板属性 | Swagger接口定义属性 | |:---|:---| | 名称 | 默认使用operationId，可在设置中配置使用summary。 | | 路径 | url + path。 | | 请求参数hostURL | servers: - url: https://{hostURL}/variable variables: hostURL: default: test.demo.com | | 其它请求参数 | parameters, requestBody, responses | #### 导入Swagger文件生成测试脚本 1. 完成[创建CodeArts TestPlan接口自动化测试用例模板](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0010.html)操作，单击用例名称，选择"脚本"页签。 2. 在右侧"关键字库"界面，单击"导入接口"。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001964032457.png) 3. 单击"点击添加文件或拖拽上传"，选择配置好的Swagger接口文档，单击"确定"。 4. 文档导入成功后，系统自动解析生成脚本模板。脚本模板包含了接口的基本描述信息。可以从"关键字库"界面单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001964032465.png)或拖拽接口添加至测试步骤，只需要按模板输入接口参数就可以测试。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001936913874.png) 导入Swagger文件常见问题请参考[导入脚本模板文件不符合Swagger规范](https://support.huaweicloud.com/testman_faq/testman_faq_0010.html)。 #### 保存自定义接口关键字 1. 完成[创建CodeArts TestPlan接口自动化测试用例模板](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0010.html)操作，单击对应的接口自动化用例名称，选择"脚本"页签。 2. 完成[使用自定义URL请求添加CodeArts TestPlan接口脚本](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0011.html)，选择需要设置为关键字的测试步骤（仅针对自定义URL请求步骤），在该测试步骤页面的右上方单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001936913866.png)，保存接口关键字。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001937073206.png "点击放大") 3. 在弹出的页面内，输入"接口关键字名"、"接口关键字描述"并选择该关键字需要储存的目录位置。关键字的默认储存位置为"接口 \> 关键字目录"中的默认文件夹。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001936913882.png "点击放大") 4. 单击"保存"完成设置。 #### 管理已添加的关键字 对于已添加的关键字，将鼠标悬浮在关键字区域时，可以选择进行以下操作。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001986232284.png "点击放大") - 单击关键字名称，可以查看关键字的详细信息。 - 单击"关键字目录"右侧的![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000002022632341.png)，可以创建文件夹。可以将[步骤3]中设置好的关键字储存在自定义的文件夹内。 - 鼠标悬浮在关键字名称的左侧区域，可以调整关键字的顺序。 - 单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000002022751877.png)或鼠标悬浮在关键字拖拽到测试步骤空白页，可以将关键字添加至测试步骤。 - 单击测试关键字任意区域，可以编辑关键字对应用例详情。 - 单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001986232340.png "点击放大")，可以查看该关键字的信息。 - 单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000001986072584.png)，可禁用关键字，再次单击可解除禁用。 - 单击![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000002022632401.png)，可从操作步骤中删除该关键字。 - 用户可以修改已保存的关键字协议类型。 ![](https://support.huaweicloud.com/usermanual-testman/zh-cn_image_0000002232418062.png "点击放大")