perfect-space/laravel-api-consumer

由black bits编写,Perfect Space编辑的优秀的Laravel Api Consumer

0.2.2 2018-06-04 05:40 UTC

This package is auto-updated.

Last update: 2024-09-11 02:42:25 UTC


README

Latest Version on Packagist Total Downloads

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

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

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

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

免责声明

此包目前正在开发中,尚未准备好用于生产。

安装

您可以通过composer安装此包

composer require perfect-space/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的网站和咨询公司。您可以在我们的网站上找到我们做什么的概述:blackbits.io

许可

MIT许可证(MIT)。有关更多信息,请参阅许可文件