Download the PHP package api-skeletons/laravel-api-problem without Composer

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

Informations about the package laravel-api-problem

API Problem for Laravel

Build Status Code Coverage PHP Version

This repository implements RFC 7807 "Problem Details for HTTP APIs" for Laravel.

Installation

Run the following to install this library using Composer:

Quick Start

This will result in a 401 response with header

and content

Use

Using the facade

You may use the ApiProblem object in two ways. First, you can use the facade to return a response quickly and directly as shown in the Quick Start. When using the facade the arguments to the response() method are:

Creating an object

When creating an ApiProblem object directly, the first two parameters are swapped. The reason for this is the constructor for the original object remains unchanged and the response() function is modified to match the standard Laravel response format.

An example of creating an object directly:

Additional Details

The 5th parameter to ApiProblem is $additional. This array adds adhoc properties to the JSON response. One method of using this array is a 422 response with details of the problem:

results in:

Use with the Exception Handler

Attribution

The bulk of this repository was copied from Laminas API Tools. I wanted to provide a simplified interface specific to Laravel. Though the tool could have been used directly from the Laminas library it would have come with a lot of overhead.

All versions of laravel-api-problem with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
doctrine/instantiator Version ^2.0
laravel/framework Version ^8.0 || ^9.0 || ^10.0 || ^11.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 api-skeletons/laravel-api-problem contains the following files

Loading the files please wait ....