myerscode / laravel-api-response

一个流畅的辅助程序和外观，确保在 Laravel 和 Lumen 中 API 响应的一致性和幂等性

维护者

详细信息

github.com/myerscode/laravel-api-response

主页

源代码

问题

安装次数：15,931

依赖项: 0

建议者: 0

安全性: 0

星标: 4

关注者: 2

分支: 0

开放问题: 0

11.0.0 2024-09-15 15:54 UTC

Requires

Requires (Dev)

MIT 47f2894de28b936a5fb6d75adb5b533c6d73c9b7

apifluentresponseconsistentbodyidempotent

This package is auto-updated.

Last update: 2024-09-15 22:55:37 UTC

README

一个流畅的辅助程序，用于在 Laravel 中提供一致形状的 API 响应

Latest Stable Version Total Downloads License Tests codecov

为什么这个包很有用？

此包确保您的 API 总是返回相同的信封形状，这样消费应用程序总是知道该期待什么！

安装

您可以通过 composer 安装此包

composer require myerscode/laravel-api-response

使用方法

在一个 Laravel 控制器中，您只需构建您的响应并返回它！

api() 辅助函数返回一个 Builder 响应，因为它实现了 Responsable 特性，您不需要做任何比返回构建器更多的事情

使用 api() 辅助函数

function resource()
{
    return api()->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
}

使用 Builder 类

function resource() {
    $buillder = new Builder();
    $builder->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
    return $builder;
}

将返回以下 JSON 响应。

{
    "status": 201,
    "data": {
        "name": "Foo Bar"
    },
    "meta": [],
    "messages": [
        "Record Created!"
    ]
}

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。