rest-assured之Schema validation(包括JSON Schema validation及Xml Schema validation)

　　rest-assured从2.1.0版本开始支持 Schema 验证，包括JSON Schema validation及Xml Schema validation。我们之前断言响应体都是一个一个字段来进行断言，这样如果断言的字段比较多的话就非常的麻烦，为了解决这个问题，我们可以使用schema文件来进行响应体的断言，schema文件可以断言整个response 。

1.JSON Schema validation

例如：在classpath下面放置以下的schema文件，products-schema.json：

 {

     "$schema": "http://json-schema.org/draft-04/schema#",

     "title": "Product set",

     "type": "array",

     "items": {

         "title": "Product",

         "type": "object",

         "properties": {

             "id": {

                 "description": "The unique identifier for a product",

                 "type": "number"

             },

             "name": {

                 "type": "string"

             },

             "price": {

                 "type": "number",

                 "minimum": 0,

                 "exclusiveMinimum": true

             },

             "tags": {

                 "type": "array",

                 "items": {

                     "type": "string"

                 },

                 "minItems": 1,

                 "uniqueItems": true

             },

             "dimensions": {

                 "type": "object",

                 "properties": {

                     "length": {"type": "number"},

                     "width": {"type": "number"},

                     "height": {"type": "number"}

                 },

                 "required": ["length", "width", "height"]

             },

             "warehouseLocation": {

                 "description": "Coordinates of the warehouse with the product",

                 "$ref": "http://json-schema.org/geo"

             }

         },

         "required": ["id", "name", "price"]

     }

 }

我们可以通过上面的schema文件来验证 "/products" 这个请求的响应数据是否符合规范：

 get("/products").then().assertThat().body(matchesJsonSchemaInClasspath("products-schema.json"));

matchesJsonSchemaInClasspath 是从 io.restassured.module.jsv.JsonSchemaValidator 这个类中静态导入的，并且推荐静态导入这个类中的所有方法，然而为了能够使用io.restassured.module.jsv.JsonSchemaValidator 这个类必须依赖 json-schema-validator module ，我们可以从这个网页下载它，或者是通过maven添加以下依赖来获取：

<dependency>

    <groupId>io.rest-assured</groupId>

    <artifactId>json-schema-validator</artifactId>

    <version>3.0.6</version>

</dependency>

1.1 JSON Schema Validation 设置

　　rest-assured 的 json-schema-validator module 使用的是 Francis Galiegue's json-schema-validator(fge) 库来实现验证(Validation)。如果想要配置基础 fge 库，我们可以这样写：

 // Given

 JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.newBuilder().setValidationConfiguration(ValidationConfiguration.newBuilder().setDefaultVersion(DRAFTV4).freeze()).freeze();

 // When

 get("/products").then().assertThat().body(matchesJsonSchemaInClasspath("products-schema.json").using(jsonSchemaFactory));

　　这个 using 方法允许我们传递一个jsonSchemaFactory 实例，rest-assured在进行验证的时候就会使用这个实例。这种配置就允许我们在验证响应结果时进行更详细的配置。

　　fge 库同时也允许设置validation为 checked或者unchecked，默认情况下rest-assured使用的是checked的validation，如果想要改变这个值，我们可以提供一个 JsonSchemaValidatorSettings 的实例给matcher。例如：

 get("/products").then().assertThat().body(matchesJsonSchemaInClasspath("products-schema.json").using(settings().with().checkedValidation(false)));

上面的 setting 方法是从 JsonSchemaValidatorSettings 这个类中静态导入的。

1.2 Json Schema Validation静态配置

　　让我们来想象一下，假如我们想一直使用unchecked的validation并且想设置Json Schema的版本为3，与其将JsonSchemaValidatorSettings 的实例一个个提供给所有的matchers，我们不如将它定义为一个静态的：

 JsonSchemaValidator.settings = settings().with().jsonSchemaFactory(

         JsonSchemaFactory.newBuilder().setValidationConfiguration(ValidationConfiguration.newBuilder().setDefaultVersion(DRAFTV3).freeze()).freeze()).

         and().with().checkedValidation(false);

 get("/products").then().assertThat().body(matchesJsonSchemaInClasspath("products-schema.json"));

通过上面的方式，现在任意一个导入了 JsonSchemaValidator 的matcher都会使用 DRAFTV3 作为默认的版本并且使用unchecked的validation。

　　为了重置 JsonSchemaValidato 为默认的配置，我们可以简单的调用一下 reset 方法来实现：

 JsonSchemaValidato.reset();

1.3 不依赖rest-assured的JSON Schema Valition

　　我们不依赖rest-assured也一样可以使用 json-schema-valition ，只要我们把JSON文件表示为 String 类型，我们可以这么做：

 import org.junit.Test;

 import static io.restassured.module.jsv.JsonSchemaValidator.matchesJsonSchemaInClasspath;

 import static org.hamcrest.MatcherAssert.assertThat;

 public class JsonSchemaValidatorWithoutRestAssuredTest {

     @Test public void

     validates_schema_in_classpath() {

         // Given

         String json = ... // Greeting response

         // Then

         assertThat(json, matchesJsonSchemaInClasspath("greeting-schema.json"));

     }

 }

2.Xml的 Schema 和 DTD Validation(验证)

　　通过使用 Xml Schema(XSD)或者DTD我们同样可以验证Xml响应体。

XSD例子：

 get("/carRecords").then().assertThat().body(matchesXsd(xsd));

DTD例子：

 get("/videos").then().assertThat().body(matchesDtd(dtd));

matchesXsd 方法和 matchesDtd 方法属于 Hamcrest matchers 包里，我们需要静态导入 io.restassured.matcher.RestAssuredMatchers。

巴特西

rest-assured之Schema validation(包括JSON Schema validation及Xml Schema validation)

最新文章

热门文章