saritasa/dingo-api-custom

此包已被弃用且不再维护。未建议替代包。

Saritasa 对 Dingo/Api 库的定制化

3.0.0 2024-08-06 17:02 UTC

README

PHP Unit PHP CodeSniffer codecov Release PHPv Downloads

Dingo/Api 包的定制设置和扩展

https://github.com/dingo/api

Laravel 5.x/6x

安装 saritasa/dingo-api-custom

$ composer require saritasa/dingo-api-custom

如果您使用 Laravel 5.4 或更低版本,或者 5.5+ 且禁用了 包发现,请将 BladeDirectivesServiceProvider 服务提供者在 config/app.php 中添加

'providers' => array(
    // ...
    Saritasa\DingoApi\SaritasaDingoApiServiceProvider::class,
)

定制化

注册 CustomArraySerializer 而不是 ArraySerializer

  • 不添加 'meta' 键用于元数据,所有元数据输出到根目录。

注册自定义 ApiExceptionHandler 并对异常进行特定处理,这些处理定义在 saritasa/php-common 包中

更改处理验证异常的 JSON 输出格式。

贡献

  1. 创建分支,检出
  2. 本地开发如常。代码必须遵循 PSR-1PSR-2 - 运行 PHP_CodeSniffer 以确保代码遵循风格指南
  3. 用单元测试 覆盖添加的功能 并运行 PHPUnit 以确保所有测试通过
  4. 更新 README.md 以描述新或更改的功能
  5. 将更改描述添加到 CHANGES.md 文件。使用 语义化版本控制 约定来确定下一个版本号。
  6. 准备好后,创建拉取请求

创建快捷方式

如果您已安装 GNU Make,可以使用以下快捷方式

  • make cs(代替 php vendor/bin/phpcs)- 使用 PHP_CodeSniffer 运行静态代码分析以检查代码风格
  • make csfix(代替 php vendor/bin/phpcbf)- 自动修复代码风格违规,在可能的情况下(例如,PSR-2 代码格式化违规)
  • make test(代替 php vendor/bin/phpunit)- 使用 PHPUnit 运行测试
  • make install(代替 composer install
  • make all 或不带参数的 make - 依次调用上述 installcstest 任务 - 项目将被组装,通过代码检查器检查,并通过单个命令进行测试

资源