api_service_interceptor

Description:

api service interceptor

Api Service interceptor is a Flutter package that helps you to fetch and pass data from Server within the easiest way.
API Service Interceptor #









How It Works #

Installation #
Add dependency for package on your pubspec.yaml:
dependencies:
api_service_interceptor: latest
copied to clipboard
or
flutter pub add api_service_interceptor
copied to clipboard
Features #
ApiServiceInterceptor class has two types of method

requestToServer()
multipartRequestToServer()

First describe the "requestToServer()" method. This method takes four parameters ->



Parameters
Definitions




String requestUrl
(Required) need to pass your API's url.


ApiRequestMethod requestMethod
(Required) need to pass API's method so that server can understand for which type of response data you want.


Object? bodyParams
(Optional) sets the body of the request. It can be a [String], a [List] or a [Map<String, String>]


Map<String, String>? headers
(Optional) need to pass headers because it helps you contain more information about the resource to be fetched, or about the client requesting the resource and also hold additional information about the response, like its location or about the server providing it.



now describe the "multipartRequestToServer()" method, and this method takes seven parameters ->



Parameters
Definitions




String requestUrl
(Required) need to pass your API's url.


String requestMethod
(Required) need to pass API's method so that server can understand for which type of response data you want.


Map<String, String> headers
(Required) need to pass headers because it helps you contain more information about the resource to be fetched, or about the client requesting the resource and also hold additional information about the response, like its location or about the server providing it.


String multipartFileField
(Required) the name of the form field for the file


String multipartFileValue
(Required) encoding to use when translating [multipartFileValue] into bytes is taken from [multipartContentType] if it has a charset set. Otherwise, it defaults to UTF-8.


String multipartFileName
(Optional) The basename of the file, and it may be null


MediaType multipartContentType
(Optional) The content-type of the file, and Defaults to application/octet-stream



Another, we have a ApiResponseModel class. This class has two field [_statusCode] and [_responseJson].

[_statusCode] store what type of status we get from the server and it is an Int type.
[_responseJson] store which response we get from the server and it is String type.
Usually ApiResponseModel is the skeleton of data which we get from Server Response.

On the other hand, we have an enums class called ApiRequestMethod. From this enums we will get our possible [requestMethod].
Basically enums, are a special kind of class used to represent a fixed number of constant values.
Usage #

/// declare ApiServiceInterceptor
final ApiServiceInterceptor apiServiceInterceptor;

/// store data ApiResponseModel
ApiResponseModel responseModel = apiServiceInterceptor.requestToServer(
requestUrl: "---------- use your api url ----------",
requestMethod: ApiRequestMethod.postRequest, /// use ApiRequestMethod to send request to Server.
bodyParams: jsonEncode({
"username": username,
"password": password
}),
headers: {'Content-Type': 'application/json'}
);

copied to clipboard
Additional Information #
This package is built on "http", "http_parser" and "shared_preferences". When we use "api_service_interceptor" package than we also use "shared_preferences" package.