Download the PHP package ejetar/laravel-api-response-formatter without Composer

On this page you can find all versions of the php package ejetar/laravel-api-response-formatter. 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 ejetar/laravel-api-response-formatter

Informations about the package laravel-api-response-formatter

API Response Formatter

Table of Contents

About

A simple and fast 🚀 library that displays responses in various formats, according to the Accept header, entered by the user. The library currently displays responses in JSON, XML, CSV, and YAML.

How it works

The API Response Formatter package provides the developer with a middleware called api-response-formatter. This middleware takes Response and converts it to a certain format based on the user's request.

In practical terms:

  1. Reads the contents of the Accept header to know which response format to display to the user.
  2. Takes the original response content provided by Laravel and convert it to the desired format;
  3. Displays the response to the user;

It also provides a custom ExceptionHandler, which allows exceptions to also be thrown in the formats you want. A very nice trick of this handler is that when the route is /api/*, it forces the response to be in JSON, CSV, YAML or XML (if no type is informed via Accept, then JSON is selected by default). This prevents the API, at some point of failure, returns an HTML error.

Example 1

Output

Example 2

Output

Example 3

Output

Example 4

Output

Installation

  1. First, run: composer require ejetar/laravel-api-response-formatter;
  2. Add Ejetar\ApiResponseFormatter\Providers\AppServiceProvider::class in providers array in config/app.php file;
  3. In app/Exceptions/Handler.php, replace Illuminate\Foundation\Exceptions\Handler with Ejetar\ApiResponseFormatter\Exceptions\Handler;
  4. In public/index.php, replace Illuminate\Http\Request::capture() with Ejetar\ApiResponseFormatter\Requests\Request::capture();

Get started

To start using this package is very simple, just call Middlware api-response-formatter in your routes/api.php file.

As in the following example:

Changelog

Nothing for now...

Contributing

Contribute to this wonderful project, it will be a pleasure to have you with us. Let's help the free software community. You are invited to incorporate new features, make corrections, report bugs, and any other form of support. Don't forget to star in this repository! 😀

License

This library is a open-source software licensed under the MIT license.

All versions of laravel-api-response-formatter with dependencies

PHP Build Version
Package Version
Requires symfony/serializer Version ^5.1
symfony/yaml Version ^5.1
laravel/framework Version ^7.17
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 ejetar/laravel-api-response-formatter contains the following files

Loading the files please wait ....