sinemacula/laravel-api-toolkit

A comprehensive Laravel toolkit for streamlined development of RESTful APIs

dev-master 2024-05-10 11:38 UTC

Requires

• php: ^8.3
• illuminate/database: ^11.0
• illuminate/http: ^11.0
• illuminate/notifications: ^11.0
• illuminate/routing: ^11.0
• illuminate/support: ^11.0
• illuminate/validation: ^11.0
• sinemacula/laravel-repositories: dev-master

Requires (Dev)

• laravel/framework: ^11.5
• phpunit/phpunit: ^11.0

Apache-2.0

• Ben Carey

• api
• toolkit
• restful
• laravel
• sine macula

README

The Laravel API Toolkit is a comprehensive package designed to simplify the development of RESTful APIs in Laravel. It provides tools to enhance API functionality, improve error handling, and ensure consistent data output, making API development faster and more reliable.

Features

• Exception Handling: Implements a custom exception handler that captures and formats all exceptions for consistent API error responses.
• Queryable Models: Allows fine-tuned control over which fields are exposed via your API endpoints, enhancing security and customization.
• Data Repositories: Abstracts database interactions into repositories to promote a cleaner and more maintainable codebase.
• Data Resources: Ensures consistent presentation of data across different API endpoints, simplifying client-side data integration.

Installation

To install the Laravel API Toolkit, run the following command in your project directory:

composer require sinemacula/laravel-api-toolkit

Configuration

After installation, publish the package configuration to customize it according to your needs:

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

This command publishes the package configuration file to your application's config directory, allowing you to modify aspects such as exception handling behaviors, data repository settings, and more.

Usage

Detailed usage instructions will be provided soon. This section will cover how to integrate the toolkit into your Laravel application, including setting up queryable models, using data repositories, and applying data transformers.

Contributing

Contributions are welcome and will be fully credited. We accept contributions via pull requests on GitHub.

Security

If you discover any security related issues, please email instead of using the issue tracker.

License

The Laravel API Toolkit repository is open-sourced software licensed under the Apache License, Version 2.0.