jonjomckay/symfony-api-problem

A Symfony-compatible response for the IETF Problem Details for HTTP APIs RFC

1.0.1 2014-09-30 18:06 UTC

This package is auto-updated.

Last update: 2022-08-07 10:46:39 UTC


README

Introduction

This library supplies a Symfony-compatible Response class, that accepts an ApiProblem object and returns a JSON object compilant with the Problem Details for HTTP APIs specification.

It is based on, and uses the ApiProblem class from, the ZF Campus zf-api-problem library for Zend Framework 2.

Installation

Run the following command to install using composer:

$ composer require "jonjomckay/symfony-api-problem:~1.0-dev"

Or add the following line to your composer.json:

"require": {
    "jonjomckay/symfony-api-problem": "~1.0-dev"
}

Usage

use JonjoMcKay\ApiProblem\ApiProblem;
use JonjoMcKay\ApiProblem\ApiProblemResponse;

class FakeController
{

    public function fetch($id)
    {
        $entity = $this->service->fetch($id);

        if (!$entity) {
            return new ApiProblemResponse(new ApiProblem(404, 'Entity not found'));
        }

        return $entity;
    }
}

License

This project is released under the BSD 3-Clause license, and is based on parts of the ZF Campus zf-api-problem library for Zend Framework 2.