Table of Contents #

• Installation
• Features
  • Network APIs Handler
  • API Cache Management

Installation #

Follow these steps to install and integrate API Services into your Flutter project:

1. Add Dependency

Add TS Essentials to your pubspec.yaml file under the dependencies section:

dependencies:
  baaba_api_handler: ^1.0.2

2. Install Packages

Run the following command in your terminal to install the dependencies:

flutter pub get

3. Import the library

Import in your Dart code:

import 'package:baaba_api_handler/ts_api_handler.dart';

Features #

1. Network APIs Handler #

TS Essential provides network API handling utilities to simplify communication with external APIs and services. With TS Essential's API handling methods, you can easily make HTTP requests, handle responses, and manage network interactions in your flutter project.

Once imported, create an object of ApiServices and ApiCacheHelper into your dart code to access its features and functionalities:

ApiServices apiServices =  ApiServices.intance();

Each method within the API handler contains the following properties for configuration:

4.1 GET

You can use the following example to make GET request.

// Make a GET request
Either<Failure, Response<dynamic>> response =  await apiServices.get(endpoint: endpoint);

4.2 POST

You can use the following example to make POST request.

// Make a POST request
Either<Failure, Response<dynamic>> response =  await apiServices.post(endpoint: endpoint)

4.3 PUT

You can use the following example to make PUT request.

// Make a PUT request
Either<Failure, Response<dynamic>> response =  await apiServices.put(endpoint: endpoint);

4.4 PATCH

You can use the following example to make PATCH request.

// Make a PATCH request
Either<Failure, Response<dynamic>> response =  await apiServices.patch(endpoint: endpoint);

4.5 DELETE

You can use the following example to make DELETE request.

// Make a DELETE request
Either<Failure, Response<dynamic>> response =  await apiServices.delete(endpoint: endpoint);

GET, POST, PATCH, PUT and DELETE methods returns the response as Either<Failure, Response<dynamic>> which you can handle as demonstrated below:

// Handle the response
response.fold(
  (failure) =>  print(failure.toString()),  // Log the failure
  (success) =>  print(success.data),  // Log the response data
);

4.6 CANCEL

You can cancel the most recent API request by using the following method:

apiServices.cancelRequest();

2. API Cache Management #

TS Essentials provides the functionality of caching the API response into local database for reducing unnecessary API calls and making the app offline first. To access these functionalities in your flutter app:

ApiCacheHelper apiCacheHelper = ApiCacheHelper.instance;

All the methods provided for caching of response are as follows:

5.1 GET

This method gets the cached api response into the local database with the provided url.

APICacheDBModel? response =  await apiCacheHelper.getCacheData(url);

5.2 SET

This method sets the api response into the local database with the provided url and data.

bool isStored =  await apiCacheHelper.setCacheData(url, data);

5.3 CLEAR

This method removes the api response from the local database for the provided url.

bool isCleared =  await apiCacheHelper.clearCache(url);

5.4 EXISTS

This method checks if the cached response for the provided url is available in the local database.

bool exists =  await apiCacheHelper.isCacheExist(url);

5.5 CLEAR ALL

This method removes all the cached api response from the local database.

await apiCacheHelper.clearAllCache();