Introduction to Typed Rest Client

The typed-rest-client is a powerful library for making HTTP requests in TypeScript. It offers a user-friendly interface for interacting with RESTful APIs, ensuring that the request and response types are properly managed. This library can be incredibly useful for developers looking to build robust client-side applications with strongly typed interactions with backend services.

Setup and Installation

  
  npm install typed-rest-client
  

Basic Usage

Below is a simple example of how to use the typed-rest-client to make a GET request:

  
  import * as restm from 'typed-rest-client/RestClient';

  const restClient = new restm.RestClient('sample-client');
  
  const response = await restClient.get('http://api.example.com/resource');
  if (response.result) {
    console.log(response.result);
  }
  

Handling POST Requests

  
  import * as restm from 'typed-rest-client/RestClient';

  const restClient = new restm.RestClient('sample-client');
  
  const resource = { name: 'Sample Resource' };
  const response = await restClient.create('http://api.example.com/resource', resource);
  if (response.result) {
    console.log(response.result);
  }
  

Updating Resources with PUT

  
  import * as restm from 'typed-rest-client/RestClient';

  const restClient = new restm.RestClient('sample-client');
  
  const updatedResource = { id: 1, name: 'Updated Resource' };
  const response = await restClient.update('http://api.example.com/resource/1', updatedResource);
  if (response.result) {
    console.log(response.result);
  }
  

Deleting a Resource

  
  import * as restm from 'typed-rest-client/RestClient';

  const restClient = new restm.RestClient('sample-client');
  
  const response = await restClient.del('http://api.example.com/resource/1');
  console.log(response.statusCode);
  

Authentication

  
  import * as restm from 'typed-rest-client/RestClient';
  import * as auth from 'typed-rest-client/Handlers';

  const token: string = 'YOUR_PERSONAL_ACCESS_TOKEN';
  const handler = new auth.BearerCredentialHandler(token);
  const restClient = new restm.RestClient('sample-client', null, [handler]);
  
  const response = await restClient.get('http://api.example.com/protected-resource');
  if (response.result) {
    console.log(response.result);
  }
  

Complete Application Example

Below is a full example of an application that uses typed-rest-client to interact with a RESTful API:

  
  import * as restm from 'typed-rest-client/RestClient';
  import * as auth from 'typed-rest-client/Handlers';

  const token: string = 'YOUR_PERSONAL_ACCESS_TOKEN';
  const handler = new auth.BearerCredentialHandler(token);
  const restClient = new restm.RestClient('sample-client', null, [handler]);

  async function performCrudOperations() {
    try {
      // GET request
      const getResourceResponse = await restClient.get('http://api.example.com/resource/1');
      if (getResourceResponse.result) {
        console.log(getResourceResponse.result);
      }

      // POST request
      const newResource = { name: 'New Resource' };
      const createResponse = await restClient.create('http://api.example.com/resource', newResource);
      if (createResponse.result) {
        console.log(createResponse.result);
      }

      // PUT request
      const updatedResource = { id: 1, name: 'Updated Resource' };
      const updateResponse = await restClient.update('http://api.example.com/resource/1', updatedResource);
      if (updateResponse.result) {
        console.log(updateResponse.result);
      }

      // DELETE request
      const deleteResponse = await restClient.del('http://api.example.com/resource/1');
      console.log(deleteResponse.statusCode);

    } catch (error) {
      console.error(error);
    }
  }

  performCrudOperations();
  

With these examples, you can start building applications that make full use of the typed-rest-client library for efficient and type-safe API interactions.

Hash: 897e804ffd86b854342cc35ce90786c47d310492ee672ec6ef2005f1d1602933