Download the PHP package digitonic/mdoc-api without Composer
On this page you can find all versions of the php package digitonic/mdoc-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digitonic/mdoc-api
More information about digitonic/mdoc-api
Files in digitonic/mdoc-api
Package mdoc-api
Short Description A Framework Agnostic PHP SDK to interact with the mDoc API.
License MIT
Homepage https://github.com/digitonic/mdoc-api
Informations about the package mdoc-api
mDoc API SDK
This is the official Framework Agnostic PHP SDK to interact with the mDoc API. Although framework agnostic by nature, the package also includes configurations for working in Laravel.
Package is currently in heavy development, be careful of use in production
Installation
You can install the package via composer:
Usage
Framework Agnostic Usage
Please Note: You must obtain your API key from your account profile
The mDoc API client can now be used as a dependency for communicating with various endpoints. for example, to get a list of all teams available to the API use you can use the following -
All endpoints that return data will return data as a \Illuminate\Support\Collection
. This will provide various utility methods when searching the response. For more information on Laravel Collections see https://laravel.com/docs/5.8/collections. Please note, this package does not require the full Laravel framework to be used.
Laravel Usage
In Laravel >5.5 the package will auto register the service provider. In Laravel <5.5 you must install this service provider.
In Laravel >5.5 the package will auto register the facades. In Laravel <5.5 you must install all facades manually.
You can publish the config file of this package with this command:
The following config file will be published in config/mdoc-api.php
IoC container
The IoC container will automatically resolve the MdocApi
dependencies for you when calling any endpoint. Which means you can just type hint your endpoint to retrieve the object from the container with all configurations in place.
Alternatively you may use the facades directly
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Steven Richardson
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of mdoc-api with dependencies
guzzlehttp/guzzle Version ~6.0
illuminate/support Version 5.8.*
ext-json Version *