Getting Started

Installation

npm

npm install flex-rest

pnpm

pnpm add flex-rest

yarn

yarn add flex-rest

Quick Start

Using with Axios (default)

The simplest way to get started — no extra dependencies needed:

import BaseApi from 'flex-rest'

const api = new BaseApi({
  token: 'your-bearer-token',
  baseUrl: 'https://api.example.com',
  timeout: 10000
})

const users = await api.get<User[]>('/users')
console.log(users.status) // 200
console.log(users.data)   // User[]

Using with Playwright

import { PlaywrightApi } from 'flex-rest'
import { request } from '@playwright/test'

const context = await request.newContext()
const api = new PlaywrightApi(context, 'your-bearer-token')

const users = await api.get<User[]>('https://api.example.com/users')

Using with Supertest

import { SupertestApi } from 'flex-rest'
import supertest from 'supertest'
import app from './app' // your Express app

const agent = supertest(app)
const api = new SupertestApi(agent, 'your-bearer-token')

const users = await api.get<User[]>('/users')

Using with CodeceptJS

BaseApi automatically detects the CodeceptJS context — no setup needed:

import BaseApi from 'flex-rest'

// Inside a CodeceptJS test, it uses I.sendGetRequest() automatically
const api = new BaseApi({ token: 'your-token' })
const users = await api.get<User[]>('https://api.example.com/users')

Building an API Layer

The real power of flex-rest is building framework-agnostic API classes:

import BaseApi from 'flex-rest'

interface User {
  id: number
  name: string
  email: string
}

class UserApi extends BaseApi {
  constructor(token: string) {
    super({
      token,
      baseUrl: 'https://api.example.com',
      timeout: 10000
    })
  }

  async getUsers() {
    return this.get<User[]>('/users')
  }

  async getUser(id: number) {
    return this.get<User>(`/users/${id}`)
  }

  async createUser(data: { name: string; email: string }) {
    return this.post<User>('/users', data)
  }

  async updateUser(id: number, data: Partial<User>) {
    return this.put<User>(`/users/${id}`, data)
  }

  async patchUser(id: number, data: Partial<User>) {
    return this.patch<User>(`/users/${id}`, data)
  }

  async deleteUser(id: number) {
    return this.delete(`/users/${id}`)
  }
}

This UserApi class works identically whether Axios or CodeceptJS is the underlying transport.

What's Next?

• Learn about the Unified Response format
• Set up Authentication
• Explore each Integration in detail