diegograssato/sf-api-problem

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

Maintainers

Details

github.com/diegograssato/sf-api-problem

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 2

1.0 2016-07-04 02:21 UTC

Requires

BSD-3-Clause 04d4370b256f5d13ed47babbede2c9533d3e7bdc

This package is auto-updated.

Last update: 2024-11-28 14:33:43 UTC

README

Introduction

This library supplies a Symfony 3 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 "diegograssato/sf-api-problem:~1.0"

Or add the following line to your composer.json:

"require": {
    "diegograssato/sf-api-problem": "~1.0"
}

Usage

use DTUX\ApiProblem\ApiProblem;
use DTUX\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;
    }
}

Configure listener

services:
    you_bundle.kernel.listener.api_exception:
        class: DTUX\ApiProblem\EventListener\ApiExceptionListener
        arguments:
          - '@logger'
        tags:
          - { name: kernel.event_listener, event: kernel.exception, method: onKernelException }

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.