sealabr / client-core

Library that helps you create a RestFul API client

Client Core

Client Core is a libary helping you to create a client RestFul API.

Installation

npm install @coaktion/client-core

Generate docs

npm run generate-docs

Usage

import {
  ClientBasic,
  ClientOptions,
  defaultClientOptions
} from '@coaktion/client-core';
import { AxiosResponse } from 'axios';

class ApiClient extends ClientBasic {
  constructor(baseUrl: string, _options?: ClientOptions) {
    super(baseUrl, {
      ...defaultClientOptions,
      endpoints: {
        search: '/resources',
        fetch: '/resources/:id',
        create: '/resources',
        update: '/resources/:id',
        delete: '/resources/:id'
      }
    });
  }

  async custom(id: string): Promise<AxiosResponse> {
    return this.makeRequest('GET', '/resources/:id/custom'.replace(':id', id));
  }
}

const apiClient = new ApiClient('https://api.example.com');

apiClient.search({ query: 'test' }).then((response) => {
  console.log(response.data);
});

apiClient.fetch('123').then((response) => {
  console.log(response.data);
});

apiClient.create({ name: 'test' }).then((response) => {
  console.log(response.data);
});

apiClient.update('123', { name: 'test' }).then((response) => {
  console.log(response.data);
});

apiClient.delete('123').then((response) => {
  console.log(response.data);
});

apiClient.custom('123').then((response) => {
  console.log(response.data);
});

License

Client Core is Copyright.

Author