Use APIMatic API to generate SDKs in Python, Typescript, PHP, Ruby, and GO. You can generate On-Prem portal and many more.
Project description
Getting Started with Apimatic API
Introduction
This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine
Install the Package
The package is compatible with Python versions 3 >=3.7, <= 3.11
.
Install the package from PyPi using the following pip command:
pip install sdksio-apimatic-sdk==3.0.0
You can also view the package at: https://pypi.python.org/pypi/sdksio-apimatic-sdk/3.0.0
Test the SDK
You can test the generated SDK and the server with test cases. unittest
is used as the testing framework and pytest
is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
pip install -r test-requirements.txt
pytest
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
Parameter | Type | Description |
---|---|---|
http_client_instance |
HttpClient |
The Http Client passed from the sdk user for making requests |
override_http_client_configuration |
bool |
The value which determines to override properties of the passed Http Client from the sdk user |
http_call_back |
HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
timeout |
float |
The value to use for connection timeout. Default: 60 |
max_retries |
int |
The number of times to retry an endpoint call if it fails. Default: 0 |
backoff_factor |
float |
A backoff factor to apply between attempts after the second try. Default: 2 |
retry_statuses |
Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
retry_methods |
Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT', 'GET', 'PUT'] |
custom_header_authentication_credentials |
CustomHeaderAuthenticationCredentials |
The credential object for Custom Header Signature |
The API client can be initialized as follows:
client = ApimaticapiClient(
custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
authorization='Authorization'
),
environment=Environment.PRODUCTION
)
Authorization
This API uses the following authentication schemes.
List of APIs
- APIs Management
- Code Generation-Imported APIs
- Code Generation-External APIs
- Docs Portal Management
- API Validation-Imported APIs
- API Validation-External APIs
- Transformation
Classes Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sdksio-apimatic-sdk-3.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90ee5456ca31ced3612104c3c648933d9494b1e228cd5c64ceed7510bebe4281 |
|
MD5 | 2a31d30cea6bedfbbb155eae70c0d368 |
|
BLAKE2b-256 | 6d0edf23ee5102cf09b14d5eab3983ee53143749f2d438a0dbf9ad6f5641af8b |
Hashes for sdksio_apimatic_sdk-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 112ad5ac52ad58ffc83b4ee3bedf1ab565dd9d1c16925dd98e16d59486388d27 |
|
MD5 | a77976133366eccee1b68b53402cbe00 |
|
BLAKE2b-256 | c65a48d99577a1d5223471c6d353f872ecc146ff35cd039561fecd2b89ea0c70 |