Download the PHP package redrat/api-helper-bundle without Composer
On this page you can find all versions of the php package redrat/api-helper-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-helper-bundle
Api Helper Bundle
This Symfony bundle provides configuration to validate and convert data for API routes.
First question, why?
Because I needed a bundle with configurable url prefix to use as API routes. For default in Symfony, only requests with content type multipart/form-data and application/x-www-form-urlencoded will have Request class with parameters data easily accessible by get() method, as example below.
With this bundle will be possible to configure which routes will work as API routes and any request with content type application/json will have Request class with parameters data easily accessible too.
Okay, how to install then?
Easy my friend, install with the composer.
Configure the bundle (if necessary)
If your composer don't like Symfony recipes contrib, don't worry, you can configure too.
-
Open
config/bundles.phpand add the bundle like below. - Create
config/packages/redrat_api_helper.yamland set initial config like below.
How to bundle works?
This bundle works with a configuration defined in config/packages/redrat_api_helper.yaml. Into this file you will config which url path prefix will work as API url, like example below:
You can configure one or more url path prefixes as you need.
After this, all url path that matches with a configuration will be acted by the bundle and will be validated and data putted into request class.
Look that only routes that matches will be acted by the bundle, like example below using configuration above.
Validations
This bundle performs 2 validations in a route matched with configuration.
Content-type
Route matched should have application/json as Content-Type with methods POST, PUT and PATCH.
If not pass by this validation, bundle will return error below.
Methods GET and DELETE normally don't contain body data, then these methods isn't validated.
Valid json data
Route matched should have valid RFC7159 json data in body. If not pass by this validation, bundle will return error below.
Author
Me and the contributors.
License
The cute and amazing MIT.
All versions of api-helper-bundle with dependencies
ext-json Version *
symfony/framework-bundle Version ^4.4 || ^5.0
symfony/yaml Version ^4.4 || ^5.0
fig/http-message-util Version ^1.1