Download the PHP package zmaglica/rick-and-morty-api-wrapper without Composer
On this page you can find all versions of the php package zmaglica/rick-and-morty-api-wrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zmaglica/rick-and-morty-api-wrapper
More information about zmaglica/rick-and-morty-api-wrapper
Files in zmaglica/rick-and-morty-api-wrapper
Package rick-and-morty-api-wrapper
Short Description Wrapper for The Rick and Morty API with query builder
License MIT
Homepage https://github.com/zmaglica/rick-and-morty-api-wrapper
Informations about the package rick-and-morty-api-wrapper
The Rick and Morty API wrapper with query builder
This PHP package is wrapper for https://rickandmortyapi.com/ with query builder that is similar to Doctrine and Laravel database query builder. It contains popular function like where clauses, easy pagination, eager loading of results and many other things.
Installation
You can install the package via composer:
Usage
Default query function that can be use on all API endpoints
Default functions that can be used AFTER request is performed
Create instance of API wrapper like this
You can set up your own GuzzleHTTP client by calling setClient()
method . Also you can pass array to class constructor to add custom Guzzle HTTP configuration options
Character
Character API documentation can be found here: https://rickandmortyapi.com/documentation/#character
First, create instance of API wrapper
After that call method character()
where you can execute API calls for character schema
After that you can execute The Rick and Morty API calls.
Examples:
Get all characters
Get single character
Get multiple characters
Get character origin location
Get character last known location
Add "Status" filter to request
Add "Gender" filter to request
Run custom query parameter using built-in where functionality
Same query can be achieved by using this:
Custom filtering can be achieved by using available filter with where clause (whereFilterName)
After you execute API call you can fetch location and episodes from founded characters using these methods:
Here is the example of getting all episodes of female characters that are alive.
Todo
- Add more examples and update documentation for Location and Episode API
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
- Zvonimir Maglica
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
PHP Package Boilerplate
This package was generated using the PHP Package Boilerplate.