• Prerequisites
• Installation
  • Install Node.js and pnpm
  • Install Node Modules
  • Install TypeScript
• Running Tests
• Generating HTML Reports
• Making HTTP Requests
• Generating Fake Data
• Additional Jest Matchers
• Usage
• Example

• Node.js >= 20.0
• pnpm >= 9

Ensure you have Node.js and pnpm installed. You can download them from the following links:

• Node.js
• pnpm

To install the required node modules, run:

pnpm install

• npm test to run all test

To generate HTML reports for your tests, you can use jest-html-reporters. The configuration is already set up in jest.config.ts.

This project uses axios for making HTTP requests. You can find the helper functions for making GET, POST, PATCH, and DELETE requests in src/helper/apiHelper.ts.

This project uses faker for generating fake data. You can find an example of how to use faker in src/helper/create.ts.

This project uses jest-extended for additional Jest matchers. The configuration is already set up in jest.config.ts.

const { HttpGet, HttpPost, HttpPatch, HttpDelete } = require('../helper/apiHelper');
const { baseUrl, getEndpoint } = require('../config/config');

const { HttpGet, HttpPost, HttpPatch, HttpDelete } = require('../helper/apiHelper');
const { baseUrl, getEndpoint } = require('../config/config');

describe('API Testing Framework', () => {
  test('should get all posts', async () => {
    const endpoint = getEndpoint('getPosts');
    const response = await HttpGet(`${baseUrl}${endpoint?.path}`);

    expect(response.status).toEqual(200);
    expect(response.data).toBeInstanceOf(Array);
  });
});