sinemacula/laravel-api-toolkit

一个综合性的Laravel工具包,用于简化RESTful API的开发

v1.1.3 2024-08-22 00:05 UTC

This package is auto-updated.

Last update: 2024-09-22 00:22:37 UTC


README

Latest Stable Version Build Status StyleCI Maintainability Test Coverage Total Downloads

Laravel API Toolkit是一个综合性的包,旨在简化Laravel中RESTful API的开发。它提供工具来增强API功能,改进错误处理,并确保数据输出的一致性,使API开发更快更可靠。

功能

  • 异常处理:实现自定义异常处理器,捕获并格式化所有异常,以实现一致的API错误响应。
  • 可查询模型:允许您精确控制通过API端点公开的字段,增强安全性和自定义性。
  • 数据仓库:将数据库交互抽象为仓库,以促进代码库的整洁性和可维护性。
  • 数据资源:确保跨不同API端点数据的一致性表示,简化客户端数据集成。

安装

要在您的项目目录中安装Laravel API Toolkit,请运行以下命令

composer require sinemacula/laravel-api-toolkit

配置

安装后,发布包配置以根据您的需求进行自定义

php artisan vendor:publish --provider="SineMacula\ApiServiceProvider"

此命令将包配置文件发布到您的应用程序配置目录,允许您修改异常处理行为、数据仓库设置等。

用法

详细的用法说明将很快提供。本节将介绍如何将工具包集成到您的Laravel应用程序中,包括设置可查询模型、使用数据仓库和应用数据转换器。

贡献

欢迎贡献,并将得到充分认可。我们通过GitHub上的拉取请求接受贡献。

安全

如果您发现任何安全问题,请通过电子邮件报告,而不是使用问题跟踪器。

许可协议

Laravel API Toolkit仓库是开源软件,受Apache许可证第2.0版许可。