README

MediaMonks Rest API

This library contains an event subscriber to easily create a Rest API with the Symfony HttpKernel. By default this library will output according to our MediaMonks Rest API spec but since we believe it could be very useful for other companies too it's very easy to extend it or implement your own.

Highlights

• Thrown exceptions will be converted automatically
• Supports custom serializers like JMS, uses json serializer by default
• Supports custom response models
• Supports application/json, application/x-www-form-urlencoded & multipart/form-data input
• Supports method overriding
• Supports forcing a "200 OK" status method
• Supports paginated responses
• Supports wrapping json response in a method (jsonp) and post message
• Should work with any framework that uses HttpKernel

Documentation

Documentation and examples can be found in the /docs folder.

Requirements

• PHP >= 8.0

To use the library.

Installation

For Symfony Framework users it is recommended to install the Rest API Bundle instead of this library.

Install this package by using Composer.

$ composer require mediamonks/rest-api

Security

If you discover any security related issues, please email devmonk@mediamonks.com instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.