APIClient

Integration (Cocoapods)

There're three podspecs:

• APIClient/Core contain pure interface / types used to abstract from implementation. Use it only in case you're about to provide custom implementation of request executor.
• APIClient/Alamofire contain AlamofireRequestExecutor implementation.

Usage

Any requests should be made through APIClient's instance. It's constructor requires specifying at least request executor. In case of APIClient/Alamofire it's AlamofireRequestExecutor (that in turn initialized with base url to your server and optioanlly SessionManager that could be customized if needed). You could also provide a list of plugins that will be used by that client (by default you got ErrorPreprocessorPlugin(errorPreprocessor: NetworkErrorProcessor()) so don't forget to include it in case you're using own list) and deserializer (which is JSONDeserializer by default).

Next step is to declare your request. Requests are pure objects(values) that used to provide required data. Your request should conform to one of the three available types: APIRequest, DownloadAPIRequest, or MultipartAPIRequest (names corresponds to their roles). Both DownloadAPIRequest and MultipartAPIRequest are inherited from APIRequest so you can provide any required data (like headers, parameters, encoding etc). You must at least specify path for basic request.

Finally, you call execute(request:parser:completion: method of your client in order to execute your request. Here you also have to specify parser (an instance of ResponseParser protocol). You got DecodableParser and You got JSONParser out of the box.

PluginType

APIClient adopted plugins behavior that allows you to have almost complete control over it's execution flow. You can define your own plugin (by implementation of PluginType protocol and passing it to client through constructor) that will replace/modify/log/resolve/decorate etc any passing request. Refer to PluginType to find documented list of methods.

APIClient also include some basic plugins.

AuthorizationPlugin

allows you to authorize your requests by passing token in it's headers. To use it you need to provide AuthorizationCredentialsProvider to the plugin and mark your request as authorizable by implementing emtpy protocol AuthorizableRequest.

RestorationTokenPlugin

allows you to restore your session in case of token expiration. To use it you need to provide AccessCredentialsProvider (used to obtain token-related information; it also has callbacks to handle restoration results) and callback to provide executed restoration request's result.

LoggingPlugin

simply logs any entries to the plugin using optionally provided closure.

ErrorDecoratorPlugin

used to decorate (e.g. map) incoming error NetworkError to custom type.

ErrorRecovererPlugin

allows use to simplify error recovering flow

ErrorPreprocessorPlugin

allows you to process pure ((httpResponse: HTTPURLResponse, data: Data)) response and create appropriate error.

By default, APIClient uses ErrorPreprocessorPlugin(errorPreprocessor: NetworkErrorProcessor()) which allows us to create NetworkError.response in case of unhandled errors.

Version history