sdksio / apimatic-sdk
Use APIMatic API to generate SDKs in Python, Typescript, PHP, Ruby, and GO. You can generate On-Prem portal and many more.
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- apimatic/core: ~0.3.0
- apimatic/core-interfaces: ~0.1.0
- apimatic/unirest-php: ^4.0.0
Requires (Dev)
- phan/phan: 5.4.2
- phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "sdksio/apimatic-sdk:3.0.0"
Or add it to the composer.json file manually as given below:
"require": { "sdksio/apimatic-sdk": "3.0.0" }
You can also view the package at: https://packagist.org/packages/sdksio/apimatic-sdk#3.0.0
Test the SDK
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-dev
dependencies. - Run
vendor\bin\phpunit --verbose
from commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verbose
instead.
You can change the PHPUnit test configuration in the phpunit.xml
file.
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
The API client can be initialized as follows:
$client = ApimaticAPIClientBuilder::init() ->customHeaderAuthenticationCredentials( CustomHeaderAuthenticationCredentialsBuilder::init( 'Authorization' ) ) ->build();
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