This is an API automation framework that has an enhanced asserting and validating options with playwright.
Used Framework: https://playwright.dev/docs/test-api-testing
npm install
Configure the dotenv package and create a .env file from the sample.env file. Enter your base URL and token in the env file.
If you clone the repo, there is a file named Playwright.config.ts
It contains all the default Pre-headers for executing our test framework. As Playwright is a standalone framework, we only need this config file for performing API tests, where it will handle all types of default headers and authorization. By using dot env package, you can easily initialize the baseURL and token from this config file only.
For executing different API scenarios, you may need to use .post method to send a post request; which can basically create any object. For a neat and robust experience, a user can create custom payload for different type of post requests within exportable-functions.
In this file, insert your desired response status based on your project documentation. Ensure that all the responses are according to the positive and negative scenarios, otherwise, all utils will fail.
This framework has several Utils that works and verifies all types of API requests. All the requests are categorized as positive and negative requests. By default, store all test cases are stored inside the tests' folder. When a user writes a new test case, here are some steps they need to follow for successful execution. In this manner, you can add many test cases and assertions at once to test out API's for them.
Send Get request and verifies positive test scenarios
Parameters
- extension
string: End point of BaseURL.
Returns
- Json respone
Send Post request and verifies positive test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Put request and verifies positive test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Patch request and verifies positive test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Delete request and verifies positive test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Get request and verifies negative test scenarios
Parameters
- extension
string: End point of BaseURL,
Returns
- Json respone
Send Post request and verifies negative test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Put request and verifies negative test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Patch request and verifies negative test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
Send Delete request and verifies negative test scenarios
Parameters
- extension
string: End point of BaseURL, - payload
Json: Payloads for requests
Returns
- Json respone
-
We need to import test and expect from playwright playwright library in the beginning of the code to use all the functions.
-
Import the payload.js only for the post requests if it requires.
-
Import all the utils functions from utils page in order to work with the enhancements.
-
We will use a test block of playwright to initialize our test case. Note: Each time user will write a new test scenario, request and baseURL is needed to pass inside async array function so that one can use these functions inside one test block.
test("A new test scenario", async () => {}); -
Inside the test case please declare one constant and inside that make a request according to your need from our utils, like,
const result = await GetPositiveResponse("Extention of the baseURL"); -
For verification, you can now console log the declared variable, and it will return the result with JSON format directly. One don't need to check with any default expect method like
expect (response.status()).toBe(200)to be written multiple times. Utils functions covers all the default assertion method. So if you need to verify specific data inside the response then, you can use expect function, but apart from that, utils covered all. -
In the Utils, you can implement a custom matcher named
toBeWithinRangewhich verifies the range for requests. You can make changes to Utils and modify it accordingly.
In this manner, you can add many test cases and assertions at once to test out API's for that.
To run all the test scripts available on the specs folder
npx playwright test
To run a single file
npx playwright test filename.test.js
Playwright has an in-built reporting tool, and it also supports 3rd party reports. To use in-built report, you should just add reporter: 'html' in the config file and after each execution, a report will be generated. For more information about how to configure reports in playwright, refer to the documentation: https://playwright.dev/docs/test-reporters