apis-service v0.0.11

API Service 🚀

Do you want to interact with other microservices or third party APIs of applications such as Payment gateways, Analytics, Social media integration, Geolocation Services or any application seamlessly without having to worry about signing in & the token being expired?

• Well, we can call any of the APIs by simply calling a function which will be calling the service's API under the hood. 😇
• This package will take care of injecting headers, throwing the errors, parsing the data by use of a simple function. 🙀

Example

Application of the Service class 🔥

Here's an application of the Service class in the client's code. In this example, we will interact with the Blog Application. In your application, you will have to create an instance of the Blog & you will be able to call all of it's APIs.

   const blog = new Blog({
    'baseURL': 'https://reqres.in/api',
    "email": "eve.holt@reqres.in",
    "password": "cityslicka",
    saveDataFn: (..._args) => {
      // This function can be used for saving the newly generated token in to a file/database/storage  
    },
  })

We'll fetch a list of users with a function which will call the Blog's API under the hood. Even if the token is expired or not passed, the function will regenerate on it's own and call the API on it's own

try {    
   const getUserResult=await blog.getUser(2)
} catch (error) {
  if(error instanceof BlogClientError)  {
    // Write your code 
  } else if(error instanceof BlogInternalServerError)  {
    // Write your code 
  }
}

Implementation of Service Class ⚙️

Now, we will see how can we create a Blog class and implement the Service class to call the APIs under the hood. For better understanding, please refer to Blog.ts

1. Inheritance

We have inherited the Blog class from the Service class which will provide it's functionality by default

class Blog extends Service<BlogConfigI> {

}

2. Setting headers for authenticated APIs

Authenticated APIs require a token which you can include in the _headersInjector. Some APIs might not require a token then you can skip them with an if condition. _headersInjector() is optional because some APIs might not required tokens at all

 protected async _headersInjector(params: URLParamsI) {
    const headers: KeyStringStringI = {}
    if (![params.path.includes('/login'),params.path.includes('/register')].includes(true)) {
      headers['Authorization'] = `Bearer ${this._config.token!}`
    }
    return headers;
  }

3. GET Method's API Request

We are calling a get method's API, we're passing the method, path & id as arguments. Also, we have passed the response's interface as a generic type of the functions. After we receive the response, we are validating the data with zod. (optional). We will understand about the function in the catch block later on.

  public async getUser(id: number): Promise<GetUserResI> {
    try {
      const response = await this._apiCall<GetUserResI>({ method: 'GET', path: '/users', id })
      const { data: resData, error: resError } = GetUserResSchema.safeParse(response)
      if (resError) {
        throw new BlogResDataError(resError.errors)
      }
      return resData;
    } catch (error) {
      throw this._handleCatch(error)
    }
  }

3. POST Method's API Request

We're receiving a params which will be validated and passed as a payload in the _apiCall function have a param which is being validated before the API call. We are validating & returning the response from this function.

  public async createUser(params: CreateUserReqI): Promise<CreateUserResI> {
    try {
      const { data: reqData, error: reqError } = CreateUserReqSchema.safeParse(params)
      if (reqError) {
        throw new BlogReqDataError(reqError.errors)
      }
      const response = await this._apiCall<CreateUserResI>({ method: 'POST', path: '/users', body: reqData })
      const { data: resData, error: resError } = CreateUserResSchema.safeParse(response)
      if (resError) {
        throw new BlogResDataError(resError.errors)
      }
      return resData;
    } catch (error) {
      throw this._handleCatch(error)
    }
  }

4. We can create multiple error classes which we can use for conditional handling of the errors in the catch block

export class BlogClientError extends ServiceClientError {
  constructor(_status: number, _data: unknown | unknown[]) {
    super(_status, _data)
  }
}

5. We need to create this common _handleCatch() function for throwing the trackable errors which can be handled conditionally in that part of the code wherein this function is being called.

 protected _handleCatch(error: unknown): void {
    if (error instanceof BlogClientError) {
      const e = error as BlogClientError
      throw new BlogClientError(e.status, e.data)
    } else if (error instanceof BlogAuthError) {
      const e = error as BlogAuthError
      throw new BlogAuthError(e.status, e.data)

    } else if (error instanceof BlogReqDataError) {
      throw new BlogReqDataError(error)

    } else if (error instanceof BlogResDataError) {
      throw new BlogResDataError(error)

    } else {
      throw new BlogUnknownError(error)
    }
  }