Detailed explanation of rest assured interface testing framework

REST-assured

One 、 Interface test introduction

• What is interface testing

  • Essentially based on some kind of agreement , Send request to server , The server returns the response data , Analyze the response data , Judge whether it is consistent with our expectations , To verify whether the function is correct .

• Why do interface tests

  • Find problems earlier , Reduce R & D costs
  • Reduce the labor cost and time of regression testing , Fast quality feedback
  • It's easier to achieve continuous integration

• Interface automation test process

  1. Understand business needs

  2. Analyze the interface test scope

  3. Interface test case design

  4. Interface test framework selection , The common ones are RestAssured

  5. Interface test case writing

  6. Framework and use case maintenance

  7. Continuous integration

Two 、REST-assured Basic use

REST-assured It's a test for REST API And the designed testing framework .

1. Introduce dependencies

   <dependency>
       <groupId>io.rest-assured</groupId>
       <artifactId>rest-assured</artifactId>
       <version>4.2.0</version>
       <scope>test</scope>
   </dependency>
   

2. Grammar format

   given().
       XXXX
   when().
       XXXX
   then().
       XXXX
   

   • given： Set test presets , Include request headers 、 Request parameters 、 Request body 、cookie etc.
   • when： What to do , That is, the URL of the request （GET / POST request ）
   • then： Analysis results 、 Assertion

3、 ... and 、 Send a request

httpbin It's a test HTTP Requested URL , What parameters are passed to it , It will return any parameters .

according to http://httpbin.org/get perhaps http://httpbin.org/post The difference is get still post request .

3.1 GET request

Mode one ： Directly in URL Splice parameters after address

import org.testng.annotations.Test;
import static io.restassured.RestAssured.*;

public class Test {
    
    @Test
    public void test() {
    
        given().
        when().
                get("http://httpbin.org/get?name=jay").
        then().
            log().body(); // Return the data in the response body 
        	//log You can output the returned information to the console 
        	//log().all()  Data in all responses can be returned 
    }
}

Running results ：

Mode two ： adopt queryParam Method to add parameters

import org.testng.annotations.Test;
import static io.restassured.RestAssured.*;

public class Test {
    
    @Test
    public void test() {
    
        given().
                queryParam("name", "jay").
                queryParam("age", "22").
        when().
                get("http://httpbin.org/get").
        then().
            log().body();
    }
}

Running results ：

3.2 POST request

1. form Form parameter type

public class Test {
    
    @Test
    public void test() {
    
        given().
                formParam("name", "jay").
                formParam("password", "qwerty").
        when().
                post("http://httpbin.org/post").
        then().
            log().body();
    }
}

Running results ：

2. JSON Parameter type

String jsonData = "{\"mobilephone\":\"13323234545\",\"password\":\"234545\"}";
given().
    body(jsonData).
    contentType(ContentType.JSON). // Use body Type must be specified when 
when().
    post("http://httpbin.org/post").
then().
    log().body();

3. xml Parameter type

String xmlStr = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" +
                "<suite>\n" +
                " <class> test xml</class>\n" +
                "</suite>";

given().
	contentType(ContentType.XML).
	body(xmlStr).
when().
	post("http://www.httpbin.org/post").
then().
	log().body();

4. Upload files

REST-assured There's a name multiPart() Can specify the file (file)、 Byte array (byte-array)、 Input stream or upload file ：

given().
	multiPart(new File("D:\\match.png")).
when().
	post("http://httpbin.org/post").
then().
	log().body();

Four 、 Get a response

adopt extract().response() Assign the response result to a Response In variables of type .

Response res=
		given().
			contentType(ContentType.JSON).
			body(jsonData).
    		//headers(Map map), take JSON Multiple formats header, adopt fastjson convert to map：Map result = (Map) JSON.parse(JSON_String);
		when().
			post("http://httpbin.org/post").
		then().
			extract().response();

// Get the response time of the interface (ms)
System.out.println(res.time());
// Get response header information 
System.out.println(res.getHeader("Content-Type"));
// Get the response body information (Json Format )
System.out.println(res.jsonPath().get("lotto.lottoId"));

Gpath Use ：

Gpath It is used to extract a specific data in the response .

1. extract JSON：res.jsonPath().get("XXX.XXX.XXX");
2. extract xml：res.xmlPath().get("XXX.XXX.XXX");
3. extract HTML：res.htmlPath().get("XXX.XXX.XXX");

extract JSON Example ：

extract HTML Example ：

obtain HTML Response time , adopt Tag name . Tag name To get the value in the tag , adopt @ Property name Get the value of the attribute ：

extract xml And extraction HTML Almost the same way of using .

Be careful ：

1. REST-assured When getting the response, if the return is JSON decimal , So the corresponding Java The type is float, But in order to solve the problem of losing accuracy , Generally, it will be converted into BigDecimal.

2. If you want to convert the returned result into BigDecimal, Need to add configuration , Here's the picture ：

   

3. Convert floating point numbers to BigDecimal：BigDecimal bigDecimal = BigDecimal.valueOf(3.14159);

4. Global configuration ：

   

   Used baseURI After the global configuration, the address will be spliced automatically ：

   

5. Some basic automated processes ： For example, the test cases of login registration are written in the same Excel In file , have access to @BeforeMethod Annotation mark registration method （ Register before login ）,@Test Annotation mark login method , Define two dataprovider Method , Read separately Excel A few lines of are used as test cases for login or registration , Put these test cases in the corresponding test methods and run them in sequence .