@flownet/lib-atom-api-js

@flownet/lib-atom-api-js is a JavaScript API library designed to facilitate effortless interaction with the back-end services of an application. It uses the popular HTTP-communication library axios and qs, a querystring parsing and stringifying library with nesting support. The library's main responsibility is to handle HTTP requests and responses to accomplish particular operations. It includes methods that encapsulate the HTTP verbs: GET, POST, PUT, and DELETE.

Main Functionality

The @flownet/lib-atom-api-js manages API requests and handles endpoints in a structured and organized way. The library comprises methods to set the API base URL (set_api_url) and request token (set_req_token), essential for API calls.

All types of CRUD operations (Create, Retrieve, Update, Delete) related to 'atom' and 'report' are available. For instance, it supports list to fetch a list of items, get to receive a single item, create to add a new item, update to modify an existing item, and delete to remove an item. An additional function run is provided specifically for reporting purpose.

Each of the operations utilizes axios to handle HTTP requests and the promise concept, allowing for asynchronous operations. This allows developers to easily call back-end service endpoints and work with responses when they are ready.

Error Handling

In case of a failing request, each method acknowledges failure and captures the error message, allowing the user to handle it gracefully in the client application. This feature helps to troubleshoot and identify issues efficiently, which ultimately leads to a smooth end-user experience.

Authorization

All API calls require authorization, which is facilitated by introducing a Bearer token mechanism. This involves passing the token in the header of each API call to ensure that the user has sufficient privileges for the requested operation.

To summarize, @flownet/lib-atom-api-js is a comprehensive library focused on aiding developers to communicate effortlessly with their application's back-end services, thereby providing a seamless user experience.