如何将Swagger集成到Karate框架中

Karate 1.0及以上版本原生完整支持Swagger/OpenAPI 2.0、3.0规范，不需要额外引入第三方插件、也不需要做定制开发，不存在适配门槛，网上找不到零散集成资料是因为这个能力属于框架内置核心功能，不属于第三方扩展集成场景。

具体可落地的使用方式如下：

• 基础环境准备：将项目内Karate依赖升级到1.0及以上稳定版本，低版本无内置OpenAPI解析能力，不建议自行做兼容适配。
• 本地规范文件加载：把导出的Swagger规范文件（swagger.json/swagger.yaml/openapi.json/openapi.yaml）放到项目测试资源目录下，直接通过内置方法加载即可完成集成，示例代码：

Feature: Swagger契约校验示例
  # 读取本地Swagger规范文件
  * def specContent = karate.read('classpath:api/swagger.json')
  # 加载为Karate可识别的API规范对象
  * def apiSpec = karate.openApi(specContent)

• 远程Swagger端点加载：如果不想本地存储规范文件，可以直接拉取运行中服务的Swagger接口返回内容加载，示例代码：

# 拉取服务暴露的Swagger文档端点
* def swaggerDoc = karate.get('http://your-service-host/v2/api-docs')
* def apiSpec = karate.openApi(swaggerDoc.body)

集成完成后可以直接使用以下能力，不需要额外编码：

• 自动校验所有发出的请求路径、请求方法、参数、请求体格式是否符合Swagger定义，不符合规范的请求会直接抛出异常
• 自动校验所有接口响应的结构、字段类型是否匹配Swagger中定义的响应Schema，快速发现接口实现与文档不一致的问题
• 调用karate.openApiToKarate(apiSpec)方法，可以批量把Swagger中定义的所有接口生成基础Karate测试用例脚手架，省去手动抄接口路径、写基础校验规则的工作量
• 可以直接读取规范中定义的接口路径、参数示例，快速构造测试请求，不需要手动维护接口地址常量

小提示：如果你的Swagger文档经过网关转发做了路径前缀裁剪、或者加了自定义扩展字段，不用特意处理原文档，把裁剪后符合OpenAPI标准的内容传入解析方法就行，Karate会自动忽略非标准字段，不会影响正常校验。

内容的提问来源于stack exchange，提问作者Ac Saravanan