api_provider #

A Flutter package for making API requests easily with built-in caching, request retries, and error handling.

Features #

• Simple and easy-to-use API request handling
• Automatic caching for responses
• Request retries with exponential backoff
• Customizable headers and query parameters
• Support for GET, POST, PUT, DELETE, PATCH, DOWNLOAD and more

Installation #

Add the following line to your pubspec.yaml file:

dependencies:
  api_provider: 1.0.0

Then, run:

flutter pub get

Usage #

Import the package #

import 'package:api_provider/easy_api_provider.dart';

Initialize the provider #

void main() {
  ApiProvider.instance.init(ApiProviderConfig(
    'https://example.com/api',
    maxRedirects: 1,
    contentType: 'application/json',
    receiveTimeout: const Duration(seconds: 30),
    connectTimeout: const Duration(seconds: 30),
    responseType: ResponseType.json,
    headers: {
      'Accept': 'application/json'
    },
    onResponse: (Response response){

    },
    onError: (DioException error){

    },
    onRequest: (RequestOptions options){

    },
    authorization: 'Bearer <Your bearer token>',
    extra: {
      'key': 'value'
    },
    listFormat: ListFormat.multi,
    requestLogger: true,
  ));
  runApp(const MyApp());
}

Making a GET request #

Future<void> fetchData() async {
  final ApiResponse response = await ApiProvider.instance.get(
      '/example',
      cancelToken: cancelToken,
      params: {
        'param1': 'value1',
      },
      progressCallback: (int c, int s){
    
      },
      requestOptions: Options()
  );
}

Making a POST request #

Future<void> sendData() async {
  final ApiResponse response = await ApiProvider.instance.post(
      '/example',
      cancelToken: cancelToken,
      params: {
        'param1': 'value1',
      },
      onSendProgress: (int c, int s){

      },
      onReceiveProgress: (int c, int s){

      },
      data: {
        'key': 'value'
      },
      requestOptions: Options()
  );
}

ApiResponse Class #

Description #

The ApiResponse class is used to encapsulate the results of network requests executed using Dio. It provides details about the success or failure of the request, retrieved data, and HTTP status code.

Properties: #

• success (bool): Indicates whether the request was successful (true) or failed (false).
• statusCode (int?): The HTTP response status code (200, 400, 500, etc.).
• data (dynamic):
  • Contains the retrieved data when the request is successful (response.data).
  • Contains error details when the request fails (error.response?.data).
• url (String?): The request URL.
• message (String?): A descriptive message for debugging or logging purposes.

Contributing #

Contributions are welcome! Feel free to open issues or submit pull requests.

License #

This package is released under the MIT License. See LICENSE for details.