jonjomckay/symfony-api-problem

Symfony 兼容的响应类,用于实现 IETF 问题详情 HTTP API RFC

1.0.1 2014-09-30 18:06 UTC

This package is auto-updated.

Last update: 2024-09-07 15:07:42 UTC


README

介绍

此库提供了一个与 Symfony 兼容的 Response 类,该类接受一个 ApiProblem 对象,并返回一个符合 HTTP API 问题详情 规范的 JSON 对象。

它基于,并使用了来自 ZF Campus zf-api-problem 库的 ApiProblem 类,该库是用于 Zend Framework 2 的。

安装

运行以下命令使用 composer 安装

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

或者将以下行添加到您的 composer.json

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

用法

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;
    }
}

许可证

本项目以 BSD 3-Clause 许可证发布,并基于 ZF Campus zf-api-problem 库的部分内容。