Download the PHP package fabricio872/api-modeller without Composer
On this page you can find all versions of the php package fabricio872/api-modeller. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fabricio872/api-modeller
More information about fabricio872/api-modeller
Files in fabricio872/api-modeller
Package api-modeller
Short Description Library for translating foreign API to Doctrine-like models
License MIT
Informations about the package api-modeller
Valuable partners:
Before installation
If you are using older php then version 7.2 download with command
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Step 1: Download the Library
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
Step 2: Initialize library
Create new instance of Fabricio872\ApiModeller\Modeller
. For legacy project is easiest to implement it with Singleton pattern which gives you
instance anywhere where you call it as described here.
create new class for client adapter of your choice in this example we use GuzzleHttp/Client
create new class somewhere in your composer autoload directory with name Modeller and add your namespace
Usage
This lib uses models with Annotations similar to Doctrine Entities.
Usually they are in a directory
src/ApiModels
but they are not required to be there as long as they have correct namespace
Example model with single Resource
This is example of a model for receiving list of users from some API
endpoint parameter is endpoint which will be called.
method parameter is method with which the request will be done
default: "GET"
type parameter defines format of the received data
currently supported: "json", "xml'
default: "json"
options parameter is array that is directly passed (but can be altered as explained in setOptions section) to symfony/http-client request method as 3. parameter so use this documentation
Example model with multiple Resources
To define multiple resources you need to wrap multiple Resource annotation into single Resources annotation with identifier at beginning. This identifier is then used while calling this endpoint as described in section setIdentifier
Calling the API
Instance of class
Fabricio872\ApiModeller\Modeller
can be received like this if configuration was as described here
This controller dumps model or collection of models form this example with namespace Users::class
and sets query parameter 'page' to 2
Notice
setOptions
have alternative functionaddOptions
which merges existing and provided optionsNotice that
Modeller::get()
must have correct namespace pointing to class from configuration section
This controller dumps model or collection of models form this example with namespace Users::class
and fills the {{id}} variable from model with number 2
noticed that now method setIdentifier is required
The modeller accepts Repo object which requires namespace of model you want to build and has optional setters:
- setOptions()
- setParameters()
- setIdentifier()
setOptions
This method accepts array of options that will be merged with options configured in a model (and will override overlapped parameters) to symfony/http-client request method as 3. parameter so use this documentation
setParameters
This method accepts array and sets twig variables (same as if you render a template but here the template is endpoint parameter from model) to url configuration and can override global twig variables
setIdentifier
This method is required in case when you use multiple Resources for single model as shown in this example
Model Title
Model title is useful if your data arrives covered in another object like this
in this case your model would have title data
to map your model variable directly to myData
and not to data
object:
you can also nest ModelTitles to array with multiple options for each title for example:
this will search in incoming response for data and in it for either subTitle1 or subTitle2
All versions of api-modeller with dependencies
ext-json Version *
doctrine/annotations Version ^1.13
doctrine/collections Version ^1.6
symfony/http-client Version ^4.4|^5|^6
symfony/property-access Version ^4.4|^5|^6
symfony/serializer Version ^4.4|^5|^6
twig/twig Version ^3.3