A set of interfaces and tools for adding to the PHP Api Client for the portal
This is a toolkit to help build an API client for the portal.
The Bristol SU Api Client is a flexible API client for authenticating and accessing any API on the portal. Your module is able to register its own API routes in the client to allow others to consume your module API.
All you need to do to get started is pull the toolkit into a package, and follow the documentation.
composer require bristol-su/api-client-toolkit
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, be inspired, and create. Any contributions you make are greatly appreciated.
- Create an issue to notify us of your planned changes
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m 'Add some AmazingFeature')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request to the Development Branch
CONTRIBUTING for more information.
Distributed under the GPL-3.0 License. See
LICENSE for more information.
Toby Twigger - email@example.com
Project Link: https://github.com/bristol-su/api-client-toolkit