bristol-su/api-client-toolkit

A set of interfaces and tools for adding to the PHP Api Client for the portal

dev-develop 2020-09-02 19:06 UTC

Requires

• php: ^7.2
• psr/http-client: ^1.0
• psr/simple-cache: ^1.0

Requires (Dev)

• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.3

MIT

• Toby Twigger

README

API Client Toolkit

A toolkit for creating an API Client for a module
Explore the docs »

View Portal · Report Bug · Request Feature

Table of Contents

• About the Module
• Getting Started
• Roadmap
• Contributing
• License
• Contact

About The Toolkit

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.

Getting Started

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

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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.

1. Create an issue to notify us of your planned changes
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request to the Development Branch

See CONTRIBUTING for more information.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Toby Twigger - [e-mail]

Project Link: https://github.com/bristol-su/api-client-toolkit