बाकी का आश्वासन दिया: उपयोगी सुझाव

इस लेख में, मैंने REST- आश्वासन, REST-API परीक्षण को स्वचालित करने के लिए सबसे आम जावा पुस्तकालयों में से एक का उपयोग करने पर कुछ उपयोगी सुझाव एकत्र किए हैं।

सभी उदाहरण महत्वपूर्ण हैं, वे स्वचालित परीक्षणों के साथ 50 से अधिक परियोजनाओं में कोड-समीक्षा करने के मेरे अभ्यास से एकत्र किए जाते हैं।

एक अलग स्थान पर एंड-पॉइंट लें

ऐसा लगता है कि यह स्पष्ट है। लेकिन नहीं, काफी बार आपको अनुरोध में हार्ड-कोडेड एंड-पॉइंट के साथ कोड देखना होगा।

अंतिम वर्ग के स्थिर स्थिरांक में अंत-बिंदुओं को रखना सबसे अच्छा है। इसी समय, एंटीपैटर्न "निरंतर इंटरफ़ेस" से बचा जाना चाहिए - यह बुरा अभ्यास है।

याद रखें कि REST- आश्वस्त आपको पथ पैरामीटर बनाने की अनुमति देता है, उदाहरण के लिए:

public final class EndPoints { public static final String users = "/users/{id}"; ... } given().pathParams("id", someId).get(EndPoints.users)...; //   given().get(EndPoints.users, someId).... 

इसके अलावा, यदि आप कई प्रश्नों में एक ही आधार पथ का उपयोग करते हैं, तो इसे होटल के स्थिरांक में रखने और इसे मूल आधार पर पारित करने के लिए अच्छा अभ्यास होगा, उदाहरण के लिए:

 //   url  http://host:port/appname/rest/someEndpoints private static final basePath = "/appname/rest/"; .. //       , //      : RestAssured.basePath = basePath; //     : given().basePath(basePath)... //    ,     

परीक्षण के तहत आवेदन के मेजबान और बंदरगाह पर भी यही लागू होता है।

ContentType / Accept

ये हेडर लगभग सभी HTTP अनुरोधों में उपयोग किए जाते हैं। REST- आश्वस्त लेखकों ने इसे महसूस करते हुए, विशेष विधियों को कॉल करके उन्हें स्थापित करना संभव बनाया:

 //   : given().header("content-type", "application/json").header("accept", "application/json")...; //   : given().contentType(ContentType.JSON).accept(ContentType.JSON)...; 

इन हेडर को विनिर्देशन में या विश्व स्तर पर स्थापित करना अच्छा है। इससे आपके कोड की पठनीयता बढ़ेगी।

स्टेटसकोड, आदि।

REST- आश्वस्त HTTP प्रतिक्रिया के प्रत्येक घटक की जाँच के लिए सुविधाजनक सिंटैक्स प्रदान करता है, लेकिन व्यवहार में आप समान कोड का सामना करना जारी रखते हैं:

 //   : Response response = given()...when().get(someEndpoint); Assert.assertEquals(200, response.then().extract().statusCode()); //   : given()...when().get(someEndpoint).then().statusCode(200); 

विनिर्देशों का उपयोग करें

कोड दोहराव बुरा है। दोहराव को कम करने के लिए विनिर्देशों का उपयोग करें। REST- आश्वासन में, आप अनुरोध और प्रतिक्रिया दोनों के लिए विनिर्देश बना सकते हैं। अनुरोध के विनिर्देश में हमने उन सभी चीज़ों को बाहर रखा है जिन्हें अनुरोधों में दोहराया जा सकता है।

 RequestSpecification requestSpec = new RequestSpecBuilder() .setBaseUri("http://localhost") .setPort(8080) .setAccept(ContentType.JSON) .setContentType(ContentType.ANY) ... .log(LogDetail.ALL) .build(); //       : RestAssured.requestSpecification = requestSpec; //   : given().spec(requestSpec)...when().get(someEndpoint); 

प्रतिक्रिया के विनिर्देश में हम सभी चेक बनाते हैं जो अनुरोध से अनुरोध तक दोहराए जाते हैं।

 ResponseSpecification responseSpec = new ResponseSpecBuilder() .expectStatusCode(200) .expectBody(containsString("success")) .build(); //       : RestAssured.responseSpecification = responseSpec; //   : given()...when().get(someEndpoint).then().spec(responseSpec)...; 

आप विभिन्न प्रकार के अनुरोधों / प्रतिक्रियाओं के लिए कई विनिर्देश बना सकते हैं और उन्हें सही स्थिति में उपयोग कर सकते हैं।

वस्तुओं को बदलने के लिए अपनी बैसाखी न लिखें

आपको अपने POJO को जैक्सन ObjectMapper का उपयोग करके JSON में नहीं बदलना चाहिए, और फिर परिणामी स्ट्रिंग को अनुरोध निकाय में स्थानांतरित करना चाहिए। REST- आश्वस्त इस का एक बड़ा काम करता है। इसके लिए, उसी जैक्सन या गॉन का उपयोग किया जाता है, जो इस बात पर निर्भर करता है कि क्लासपाथ में क्या है। JAXB का उपयोग XML में कनवर्ट करने के लिए किया जाता है। मूल प्रारूप सामग्री-प्रकार के मूल्य द्वारा स्वचालित रूप से निर्धारित किया जाता है।

 given().contentType(ContentType.JSON).body(somePojo) .when().post(EndPoints.add) .then() .statusCode(201); //        : SomePojo pojo = given(). .when().get(EndPoints.get) .then().extract().body().as(SomePojo.class); 

इसके अलावा, REST- आश्वासन ने HashMap को JSON और इसके विपरीत में परिवर्तित करने का एक बड़ा काम करता है।

ग्रोवी की शक्ति का दोहन करें

REST- सुनिश्चित लाइब्रेरी खुद Groovy में लिखी गई है और आपको Groovy से प्राप्त JSON / XML प्रतिक्रिया के लिए विभिन्न तरीकों को लागू करने की अनुमति देता है। उदाहरण के लिए:

 //  find, findAll         ,  collect       . //  it         Map<String, ?> map = get(EndPoints.anyendpoint).path("rootelement.find { it.title =~ 'anythingRegExp'}"); //     ,     Map<String, ?> map = get(EndPoints.anyendpoint).path("rootelement.findAll { element -> element.title.length() > 4 }"); //     sum, max, min     ,        String expensiveCar = get(EndPoints.cars).path("cars.find { it.title == 'Toyota Motor Corporation'}.models.max { it.averagePrice }.title"); 

ग्रूवी से विधियों का उपयोग करने से आप उत्तर से आवश्यक मूल्य खोजने के लिए आपके द्वारा लिखे गए कोड की मात्रा को काफी कम कर सकते हैं।

यह सब, यदि आपके पास अधिक सुझाव और उदाहरण हैं, तो उन्हें टिप्पणियों में लिखें।