README

这个 Laravel 包允许你生成具有端点和形状的 API 消费者，其用法类似于 Laravel 的 Eloquent 模型。

你可以为每个你想要消费的 API 服务生成一个消费者。每个消费者可以有任意数量的端点，每个端点可以有多个形状。

端点表示例如 REST API 上的资源，如 /users。端点返回形状的集合。你可以在这里建模 API 提供的方法。

形状表示端点返回的对象，并允许你例如转换或验证对象的属性。

此包目前处于开发中，尚不可用于生产。

安装

您可以通过 composer 安装此包

composer require black-bits/laravel-api-consumer

接下来，您可以发布配置

php artisan vendor:publish --provider="BlackBits\ApiConsumer\ApiConsumerServiceProvider"

要创建新的 Api 消费者服务，您可以简单地运行

php artisan make:api-consumer ConsumerName

要将端点（例如 UserEndpoint）添加到此服务，请运行以下命令，这将为此端点创建默认的形状（UserShape）

php artisan make:api-consumer-endpoint UserEndpoint -c ConsumerName

要添加自定义集合回调，请运行以下命令。您可以使用此命令例如创建一个仅显示接收新闻通讯的用户过滤器的过滤功能

php artisan make:api-consumer-collection-callback ReceivesNewsletter

您可以在以下位置找到示例实现： black-bits/laravel-api-consumer-showcase

composer test

请参阅 CHANGELOG 了解最近更改的更多信息。

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

Black Bits, Inc. 是一家位于俄勒冈州 Grants Pass 的专注于 Laravel 和 AWS 的网站和咨询公司。您可以在我们的网站上找到我们做什么的概述在这里。

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