
# 关键字库
关键字驱动测试是一种测试自动化的技术，通过提供一组称为关键字的"构建块"创建自动化测试用例。关键字驱动测试可用于组件测试、系统测试等不同级别的测试，其优势体现在易用性、可理解性、可维护性、测试信息的重用、支持测试自动化、节约潜在的成本和进度等方面。在设计测试用例时，经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤，重复工作量很大，并且难以维护。测试关键字可以帮助复用这些测试步骤。
关键字库将接口关键字、组合关键字、系统关键字进行统一管理，打造一站式关键字管理能力，在设计用例脚本时用户体验保持一致。
- 接口关键字中定义单个接口的请求，可以通过导入Swagger文件、保存自定义URL请求等方式生成。
- 组合关键字用于将多个步骤封装成常用的测试步骤组合，可以引入到其他的测试用例中，实现测试逻辑复用。
- 系统关键字涵盖认证、协议、中间件、数据库四大类别，覆盖身份认证、复杂协议、数据处理、数据预置、数据验证、接口集成等丰富场景。
![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483543934.png)
#### 关键字库入口
1. 在"脚本"页签，页面右侧展示"关键字库"。 ![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515583919.png)
   - 通过Swagger文件导入的关键字放置在关键字库的"接口"页签中，详细操作请参考[接口关键字]。
   
   - 关键字用例和组合关键字放置在关键字库的"组合"页签中，支持从0到1创建新的组合关键字，详细操作请参考[组合关键字]。
   
   - 认证类、数据库操作类、中间件类、协议类等实用关键字放置在"系统"页签中，详细操作请参考[接口自动化用例关键字]。
    
2. 单击关键字库中"名称"下拉列表，可以按照"名称"、"描述"，搜索对应的关键字。 ![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383970.png)
   
 
#### 约束与限制
- 使用组合关键字高阶特性，需要特性使用授权，请联系客服处理。
- 使用系统关键字高阶特性，需要开通TestPlan专业版套餐或CodeArts专业版以上套餐。
 
 #### 接口关键字
接口关键字中定义单个接口的请求，可以通过导入Swagger文件、保存自定义URL请求等方式生成。
**导入Swagger文件生成数据**
1. 在右侧"关键字库"界面，单击"导入接口"。 ![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002515583925.png)
   
2. 在弹出的"导入接口"页面，单击"点击添加文件或拖拽上传"，选择配置好的Swagger接口文档，单击"确定"，完成Swagger文件导入。 ![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383974.png)
   
3. 文档导入成功后，系统自动解析生成脚本模板，脚本模板包含了接口的基本描述信息。可以从"关键字库"界面单击"+"或直接拖拽接口添加至测试步骤，只需要按模板输入接口参数就可以进行测试。 ![](https://support.huaweicloud.com/usermanual-apiarts/zh-cn_image_0000002483383968.png)
   
具体请参考CodeArts Testplan的[接口关键字](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0012.html)。
 #### 组合关键字
在设计测试用例时，经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤，重复工作量很大，并且难以维护。组合关键字用于将多个步骤封装成常用测试逻辑，可以被测试用例调用实现逻辑复用。
具体请参考CodeArts Testplan的[组合关键字](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0181.html)。
 #### 接口自动化用例系统关键字
接口自动化测试将常见的操作封装成关键字供用户使用，用于提升编写接口测试用例的效率。
表1系统关键字一览表 
| 分类     | 关键字集                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|
| 认证类    | - [认证类---GetIAMToken](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0122.html)  - [认证类---OAuth2ForOneAccess](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0146.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| 数据库操作类 | - [数据库类---MySQLQuery](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0123.html)  - [数据库类---MySQLUpdate](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0125.html)  - [数据库类---MySQLInsert](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0134.html)  - [数据库类---MySQLDelete](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0135.html)  - [数据库类---OpenGaussQuery](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0138.html)  - [数据库类---OpenGaussUpdate](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0139.html)  - [数据库类---OpenGaussInsert](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0140.html)  - [数据库类---OpenGaussDelete](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0141.html)  - [数据库类---PostgreSQLQuery](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0142.html)  - [数据库类---PostgreSQLUpdate](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0143.html)  - [数据库类---PostgreSQLInsert](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0144.html)  - [数据库类---PostgreSQLDelete](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0145.html)  - [数据库类---MongoDBQuery](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0130.html)  - [数据库类---MongoDBInsert](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0131.html)  - [数据库类---MongoDBUpdate](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0132.html)  - [数据库类---MongoDBDelete](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0133.html)   |
| 中间件类   | - [中间件类---RedisGet](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0136.html)  - [中间件类---RedisSet](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0137.html)  - [中间件类---OBSWrite](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0147.html)  - [中间件类---OBSDelete](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0148.html)  - [中间件类---OBSQuery](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0149.html)  - [中间件类---KafkaProducer](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1321.html)  - [中间件类---KafkaConsumer](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1322.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| 协议类    | - [协议类---TCP](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0128.html)  - [协议类---UDP](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0129.html)  - [协议类---WSConnect](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1311.html)  - [协议类---WSRequest](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1312.html)  - [协议类---WSWriteOnly](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1313.html)  - [协议类---WSReadOnly](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1314.html)  - [协议类---WSDisConnect](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1315.html)  - [协议类---MQTTConnect](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1316.html)  - [协议类---MQTTDisconnect](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1317.html)  - [协议类---MQTTPublish](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1318.html)  - [协议类---MQTTSubscribe](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1319.html)  - [协议类---DubboClient](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1320.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
具体请参考CodeArts Testplan的[接口自动化用例系统关键字](https://support.huaweicloud.com/usermanual-testman/cloudtest_01_0034.html)。
