README

该包提供了一种优雅且简单的方式来定义API路由和格式化JSON错误响应。

Laravel API
- 安装
- 安装
- 配置
- 使用
  - 错误响应
- 变更日志
- 测试
- 贡献
- 安全
- 鸣谢
- 许可证

安装

您可以使用Composer将此包安装到您的Laravel项目中

$ composer require jenky/laravel-api

安装后，使用vendor:publish Artisan命令发布其资源。

php artisan vendor:publish

或者

php artisan vendor:publish --provider="Jenky\LaravelAPI\ApiServiceProvider"

配置

发布Laravel API的资源后，其主配置文件位于config/api.php。此配置文件允许您配置API路由和错误响应格式，每个配置选项都包含其目的的描述，因此请务必彻底研究此文件。

对于头版本，如果请求没有包含正确格式的Accept头，则将使用配置中的默认版本。

使用

错误响应

在构建API时处理错误可能会很痛苦。您无需手动构建错误响应，只需抛出异常，API将为您处理响应。只需将特性ExceptionResponse添加到您的app/Exceptions/Handler中，该包将自动捕获抛出的异常并将其转换为JSON表示。

<?php

namespace App\Exceptions;

use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Jenky\LaravelAPI\Exception\ExceptionResponse;

class Handler extends ExceptionHandler
{
    use ExceptionResponse;
}

您可以在config/api.php文件中更改默认错误响应格式。

变更日志

有关最近更改的更多信息，请参阅变更日志。

测试

$ composer test

贡献

有关详细信息，请参阅贡献指南和行为准则。

安全

如果您发现任何与安全相关的问题，请通过电子邮件contact@lynh.me联系，而不是使用问题跟踪器。

鸣谢

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

jenky / laravel-api

维护者

详细信息

README

安装

安装

配置

使用

错误响应

变更日志

测试

贡献

安全

鸣谢

许可证