Easy API SL #

A Flutter package that makes API calls easy and maintainable. This package provides a simple and flexible way to make HTTP requests with built-in token management, error handling, and logging.

Features #

• 🚀 Simple and intuitive API
• 🔒 Built-in token management with shared preferences
• 📝 Comprehensive error handling
• 📊 Request/Response logging
• 🔄 Support for all HTTP methods (GET, POST, PUT, PATCH, DELETE)
• 📦 Form data support
• 🛠️ Customizable headers and base URL
• ⚡ Efficient and performant

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  easy_api_sl: ^0.1.0

Usage #

Basic Setup #

import 'package:easy_api_sl/easy_api_sl.dart';

// Create an instance of EasyApi
final api = EasyApi(
  baseUrl: 'https://api.example.com',
  token: 'your-auth-token', // Optional
);

// Make API calls
try {
  // GET request
  final response = await api.get('/users');

  // POST request
  final data = await api.post(
    '/users',
    data: {'name': 'John Doe', 'email': 'john@example.com'},
  );

  // PUT request with form data
  final formData = await api.put(
    '/users/1',
    data: {'avatar': File('path/to/avatar.jpg')},
    isFormData: true,
  );
} catch (e) {
  if (e is ApiException) {
    print('API Error: ${e.message}');
  }
}

Token Management #

// Store token
await CacheHelper.setToken('your-auth-token');

// Get token
final token = CacheHelper.getToken();

// Remove token
await CacheHelper.removeToken();

// Token will be automatically included in requests
final api = EasyApi(baseUrl: 'https://api.example.com');

Custom Headers #

final api = EasyApi(
  baseUrl: 'https://api.example.com',
  defaultHeaders: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-Custom-Header': 'value',
  },
);

// Add additional headers for specific requests
final response = await api.get(
  '/users',
  headers: {'X-Request-ID': '123'},
);

Error Handling #

The package provides specific exceptions for different error scenarios:

try {
  final response = await api.get('/users');
} on BadRequestException catch (e) {
  print('Bad Request: ${e.message}');
} on UnauthorizedException catch (e) {
  print('Unauthorized: ${e.message}');
} on ForbiddenException catch (e) {
  print('Forbidden: ${e.message}');
} on NotFoundException catch (e) {
  print('Not Found: ${e.message}');
} on ServerException catch (e) {
  print('Server Error: ${e.message}');
} on ConnectionException catch (e) {
  print('Connection Error: ${e.message}');
} on ApiException catch (e) {
  print('API Error: ${e.message}');
}

API Reference #

EasyApi #

The main class for making API requests.

Constructor

EasyApi({
  Dio? dio,
  String? baseUrl,
  String? token,
  Map<String, String> defaultHeaders = const {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
  },
  bool enableLogging = true,
})

Methods

• get(String path, {Map<String, dynamic>? queryParameters, Map<String, dynamic>? headers})
• post(String path, {Object? data, Map<String, dynamic>? queryParameters, Map<String, dynamic>? headers, bool isFormData = false})
• put(String path, {Object? data, Map<String, dynamic>? queryParameters, Map<String, dynamic>? headers, bool isFormData = false})
• patch(String path, {Object? data, Map<String, dynamic>? queryParameters, Map<String, dynamic>? headers, bool isFormData = false})
• delete(String path, {Object? data, Map<String, dynamic>? queryParameters, Map<String, dynamic>? headers, bool isFormData = false})

CacheHelper #

Utility class for token management.

Methods

• static Future<void> init() - Initialize shared preferences
• static String? getToken() - Get stored token
• static Future<bool> setToken(String token) - Store token
• static Future<bool> removeToken() - Remove stored token

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

License #

This project is licensed under the MIT License - see the LICENSE file for details.