Download the PHP package mattjanssen/api-response-bundle without Composer

On this page you can find all versions of the php package mattjanssen/api-response-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of mattjanssen/api-response-bundle

Informations about the package api-response-bundle

mattjanssen/api-response-bundle

Latest Version on Packagist Build Status

mattjanssen/api-response-bundle is a slightly-opinionated Symfony bundle for transforming controller action returns and exceptions into a standardized JSON response. The serializer and CORS headers can be configured globally, per path, and per action via annotation.

Install

Via Composer

Enable

Enable the bundle in the kernel:

Configure

The serializer can be empty, 'array', 'json_encode', 'json_group_encode', 'jms_serializer', or the name of a service which must implement the SerializerAdapterInterface. It defaults to 'json_encode'.

Usage

In your API controllers, just return whatever you want serialized in the response. The ApiResponseBundle takes care of turning that into an actual JSON response.

This would result in the following JSON return:

Status Codes

By default, responses are sent with the 200 OK status. In order to use a different status, use the @ApiResponse annotation on the controller action. This should only be used to change the success status codes. See the Error Response section for handling error output.

The resulting response would have the 201 CREATED status.

Error Response

To respond with an error, throw any exception implementing the ApiResponseExceptionInterface. On the exception you can optionally set the HTTP status code, the exception code, the exception message and the error data to be serialized into the response.

This would result in the following JSON return with a 404 HTTP status:

Exception Handling

Besides turning ApiResponseExceptionInterface exceptions into error responses, the bundle will also handle any uncaught exceptions in the following manner:

HttpExceptionInterface

The exception status code is used for both the response HTTP code and the error code. The error message is the corresponding Response::$statusTexts array value. Error data is null.

AuthenticationException

Both the response HTTP code and the error code are 401. The error message is "Unauthorized". Error data is null.

AccessDeniedException

Both the response HTTP code and the error code are 403. The error message is "Forbidden". Error data is null.

All Other Exceptions

Both the response HTTP code and the error code are 500.

If the Symfony kernel is not in debug mode, the error message is "Internal Server Error". Error data is null.

If the Symfony kernel is in debug mode, the error message is compiled from the exception class, message, file and line number. And the error data is the exception trace.

Testing

License

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

All versions of api-response-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^5.4|^7
symfony/symfony Version ^2.4|^3|^4|^5
sensio/framework-extra-bundle Version ^3|^4|^5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mattjanssen/api-response-bundle contains the following files

Loading the files please wait ....