corporateip/laravel-api-response

为 Laravel 设计的简单 API 响应工厂

维护者

详细信息

github.com/CorporateIP/laravel-api-response

源代码

问题

安装次数: 8

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 0

开放问题: 0

1.0.3 2024-09-12 06:59 UTC

Requires

  • php: ^8.1

MIT c20c5b8b48a54cf4c03880a815cf31abc3afd999

  • Jimmy <jimmy.woop@corporateip.nl>

This package is auto-updated.

Last update: 2024-09-12 07:00:03 UTC

README

此包旨在使 API 响应保持一致且易于使用。它符合 HTTP 标准和 JSend 标准。

示例

代码

function getUser($id){
    // Get the data we wish to return
    $user = User:find($id);
    
    // If the user does not exist we return an error
    if(!$user){
        return ApiResponseFactory::notFound("User does not exist");
    }
    
    // Return the data by using a ReponseFactory
    return ApiResponseFactory::success($user);
}

错误输出

{
  "status":"fail",
  "message":"User does not exist"
}

成功输出

{
  "status":"success",
  "data": { 
      "id":1,
      "name":"John Doe",
      "email":"john@example.org",
      "created_at":null,
      "updated_at":null
  }
}

安装

要安装，您可以使用 Composer，使用以下命令安装此包。
composer require corporateip/laravel-api-response

文档

即将推出！

进度

  • JSend 兼容性
  • PHPUnit 测试
  • 文档

许可协议

有关许可协议，请参阅 LICENSE 文件，此项目拥有 MIT 许可证。