Laravel API Gateway

Laravel API Gateway is a powerful package designed to facilitate the management and routing of API requests in your Laravel application. It provides features such as header manipulation, authentication, and request forwarding.

Table of Contents

• Features
• Installation
• Configuration
• Usage
  • Routing
  • Header Manipulation
  • Authentication
• Example
• Testing
• Contributing
• License

Features

• Route API requests to different endpoints.
• Manipulate request and response headers.
• Support for multiple authentication methods.
• Easy integration with existing Laravel applications.

Installation

You can install the package via Composer:

git clone https://github.com/oixan/laravel_api_gateway.git

Configuration

Configuring Routes

In your config/apigateway.php, you can define the routes for your API Gateway:

return [
    'routes' => [
        [
            'prefix' => '/service1',
            'method' => 'GET',
            'service_url' => 'https://api.restful-api.dev',
            'timeout' => 5000,
            'auth' => 'none',
        ],
        // Add more routes as needed
    ],
];

Configuring Filters

Filters allow you to process requests before they are forwarded to the target service. You can define filters in your route configuration.

Example route configuration with a filter:

return [
    'routes' => [
        [
            'prefix' => '/service1',
            'method' => 'GET',
            'service_url' => 'https://api.restful-api.dev',
            'timeout' => 5000,
            'auth' => 'none',
            'filters' => [
                \App\Filters\DefaultFilter::class
            ]
        ],
        // Add more routes as needed
    ],
];

Example Filter

Here is an example of a filter class that logs a message when processing a request:

namespace App\Filters;

use Closure;
use Illuminate\Log\Logger;
use Illuminate\Http\Request;

class DefaultFilter extends Filter
{
    /**
     * Processes the current filter without altering the request.
     * 
     * @param Request $request The request to process.
     * @param Closure $next The next callback in the chain.
     * @return mixed
     */
    protected function handler(Request $request, Closure $next)
    {
        app(Logger::class)->info('DefaultFilter is processing the request');

        return $next($request);
    }
}

Usage

Start Laravel Development Server

To start the Laravel development server, run the following command:

php artisan serve

You can now access your API Gateway at http://localhost:8000/api.

Testing with Postman

You can test your API Gateway using Postman. Make a request to the appropriate endpoint, e.g., http://localhost:8000/api/service1, and it will be routed through the gateway.

Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Create a new Pull Request.

License

This package is licensed under the MIT License. See the LICENSE file for details.