Download the PHP package r4nkt/laravel-api-responder without Composer

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

Informations about the package laravel-api-responder

API Responses for your Laravel API

Latest Version on Packagist Build Status StyleCI Quality Score Total Downloads

The r4nkt/laravel-api-responder package allows you to easily return API responses in your Laravel app.

Below is a small example of how to use it:

It will automatically resolve resources for the provided data if they exist.

Documentation

To get started follow the installation instructions below.

Installation

You can install the package via composer:

The package will automatically register itself.

You can optionally publish the config file with:

This is the contents of the published config file:

Usage

The responder can be used in several ways.

Using the Facade

Using the Trait

Using the Service Container

Custom response codes

You can set the status code of the response by using the setStatusCode method on the response from the responder.

Specific resource classes

If you would like to specify a resource class it can be passed as the second parameter to the respond method:

Forcing the usage of API resources

If you want to force the usage of API resources, you have to set the force_resources option to true in the config/responder.php file.

When set to true it will throw a ResourceNotFoundException if a resource for the associated model could not be found.

Using type suffixes

If you are using type suffixes as naming convention, when creating new resources, then you should set the use_type_suffix option to true in the config/responder.php file.

When set to true it expects your resources to be named like UserResource instead of just User.

Testing

Security

If you discover any security issues, please email [email protected] instead of using the issue tracker.

Credits

License

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

All versions of laravel-api-responder with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
illuminate/contracts Version ^9.0
illuminate/database Version ^9.0
illuminate/http Version ^9.0
illuminate/support Version ^9.0
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 r4nkt/laravel-api-responder contains the following files

Loading the files please wait ....