README.md

apimatic-core-interfaces

Introduction

This project contains the abstract layer for APIMatic's core library. The purpose of creating interfaces is to separate out the functionalities needed by APIMatic's core library module. The goal is to support scalability and feature enhancement of the core library and the SDKs along with avoiding any breaking changes by reducing tight coupling between modules through the introduction of interfaces.

Version supported

Currenty APIMatic supports Python version 3.7 - 3.11 hence the apimatic-core-interfaces will need the same versions to be supported.

Installation

Simply run the command below in your SDK as the apimatic-core-interfaces will be added as a dependency in the SDK.

pip install apimatic-core-interfaces

Interfaces

Name	Description
HttpClient	To save both Request and Response after the completion of response
ResponseFactory	To convert the client-adapter response into a custom HTTP response
Authentication	To setup methods for the validation and application of the required authentication scheme
UnionType	To setup methods for the validation and deserialization of OneOf/AnyOf union types
Logger	An interface for the generic logger facade
ApiLogger	An interface for logging API requests and responses

Enumerations

Name	Description
HttpMethodEnum	Enumeration containig HTTP Methods (GET, POST, PATCH, DELETE)