pyskunov/laravel-api-response

JsonResponse 混入

维护者

详细信息

github.com/pyskunov/laravel-api-response

源代码

问题

安装: 3

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放问题: 0

类型:软件包

1.0.1 2021-04-20 13:53 UTC

Requires

  • php: ^7.3|^8.0

MIT 844390d7ade92a7887210fb582d8ac019e7166b5

  • Vadym Pyskunov <v.pyskunov3004.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-20 21:22:19 UTC

README

此包允许以简单的方式创建 JSON 响应。

为了简化 JsonResponse 的创建，您可以使用

JsonResponse::success // 返回 JsonResponse JsonResponse::noContent // 返回 JsonResponse，状态为 204 JsonResponse::publicError // 抛出 PublicException JsonResponse::privateError // 抛出 PublicException JsonResponse::error // 返回 JsonResponse，不使用 Handler.php 中的 laravel，直接返回 JSON。

JsonResponseMixin

通过类 JsonResponseMixin 扩展 JsonResponse 功能。

异常

  • VisibilityException - PublicException & PrivateException 的父类
  • PublicException - 可以获取可打印的 $data 属性 + 有消息
  • PrivateException - 不能获取可打印的 $data 属性，只有消息

如何使用

扩展状态码

  • 创建一个新的类并扩展 StatusCodes.php
  • 添加您自己的代码或覆盖现有的代码
  • 在抛出错误时使用您自己的类

扩展混入

  • 发布供应商
  • 创建一个新的类
  • 在一个新类中编写您的宏
  • 在最近发布的 laravel-api-response 配置文件中使用您的类

待办事项

  • 添加更多状态码
  • 添加更漂亮的文档
  • 进行基本测试