README

Laravel Sunset 允许您弃用 URL（API 或其他）。

日落头是一个正在开发的 HTTP 响应头，旨在标准化标记为弃用的 URL 的方式。简而言之；它看起来像这样

Sunset: Sat, 31 Dec 2018 23:59:59 GMT

这可以与 Link: <http://foo.com/something> rel="sunset" 结合使用，这可以是任何可能帮助开发者了解情况的东西。也许链接到您的新资源的 API 文档、OpenAPI/JSON Schema 定义，甚至是一篇解释更改的博客文章。

安装

通过 Composer

composer require hskrasek/laravel-sunset

用法

在您的基控制器中，添加以下内容

<?php

namespace App\Http\Controllers;

use HSkrasek\Laravel\Sunset\SunsetsEndpoints;

class Controller {
    use SunsetsEndpoints;
}

然后，当从您的控制器返回响应时，执行以下操作

<?php

namespace App\Http\Controllers;

use HSkrasek\Laravel\Sunset\SunsetsEndpoints;

class APIController extends Controller {
    public function index()
    {
        // Other logic here
        return $this->sunsetsResponse(
            response()->json(['foo' => 'bar',]),
            '2017-12-31 23:59:59', // When this endpoint is being deprecated
            'http://example.com' // Optional link explaining the deprecation
        );
    }
}

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

测试

$ composer test

贡献

欢迎在 GitHub 上提交错误报告和拉取请求 hskrasek/laravel-sunset。该项目旨在成为一个安全、友好的合作空间，贡献者应遵守贡献者公约行为准则。

hskrasek / laravel-sunset

维护者

详细信息

README

安装

用法

变更日志

测试

贡献