doc.md

Semart Api Gateway Configuration

Main Configuration

gateway:
    prefix: /api
    host: https://arsiteknologi.com:8080
    trusted_ips: ['127.0.0.1', '::1']
    exclude_paths:
        - /public/settings
    auth:
        host: https://arsiteknologi.com:8080
        login:
            path: /login
            method: POST
        credential:
            type: json
            username:
                field: username
                value: admin
            password:
                field: password
                value: admin
        verify_path: /me #mostly profile path
        token:
            key: token
            lifetime: 3600

• prefix is the prefix of url for all services and routes. Set to null or empty string if want to avoid it.

• host is global host. if you don't set the host in auth or services, it value will be applied.

• trusted_ips are ip list that have special policy such as no request limit and auto login when call private URL without any credential.

• exclude_paths are path(s) that no request limiter applied. It mean, we don't limit request to these resources.

• auth.host (optional) is the host of authentication service. if not set, global host will be applied.

• auth.login is the login path and method. the prefix added to login path.

• auth.credential are credentnial to supply when login called.

• auth.verify_path is path that will check the token is valid or not. Basically all private page can used here.

• auth.token is config to tell how to get the token from response. ex: { token: 'thisIsSecretToken'}, so the key is token.

Route

gateway:
    routes:
        route1:
            path: /me
            methods: [GET]
            priority: 0
            public: false
            cache_lifetime: 5
            balance: roundrobin # roundrobin | random | sticky (master/slave) NB: Please noted, some balance method may not work during development
            timeout: 0
            handlers:
                - service1
                - service2

• route1 is route name

• path is route path. Will be appended with prefix if prefix is set

• methods is route methods

• priority is route priority that follow the symfony route priority

• public is mark the route as public or private route

• cache_lifetime is cache lifetime in second

• balance is load balancer method that use in route. default roundrobin

• timeout is how long we will wait the service until returning response

• handlers are list of service to handle this route

Service

gateway:
    services:
        service1:
            host: https://arsiteknologi.com:8080
            health_check_path: /status
            version: v1
            limit: 1000
            weight: 3

• service1 is service name

• host (optional) is hos of service. if not set, global host will be applied.

• health_check_path is path that indicate the service is up. Just return 200 to indicate service is available.

• version is prefix version for service that applied to route.

• limit is limit service to call if this limit reached the service is no available to give time the service to recover it self and then counter will be resetted.

• weight is service weight when using weight method as balance method

Aggregate Query

gateway:
    aggregates:
        customer_order:
            path: /customer_orders/{customerId}
            priority: 0
            cache_lifetime: 5
            handler: 'KejawenLab\SemartApiGateway\Aggregate\CustomerOrder'

• customer_order is aggregate name

• path is route path. Will be appended with prefix if prefix is set

• priority is route priority that follow the symfony route priority

• cache_lifetime is cache lifetime in second

• handler is class to handle this aggregate query. The class must implement KejawenLab\SemartApiGateway\Aggregate\AggregateRequestInterface interface. If class has dependencies in constructor, add this class to container.

Create Aggregate Query Handler

1. Create Class then implement KejawenLab\SemartApiGateway\Aggregate\AggregateRequestInterface

<?php

declare(strict_types=1);

namespace KejawenLab\SemartApiGateway\Aggregate;

use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class CustomerOrder implements AggregateRequestInterface
{
    public function handle(Request $request): Response
    {
        $customerOrders = [];
        $client = HttpClient::create();

        //Do stuff here like call Api that you need to aggregate

        return new JsonResponse(['customer_orders' => $customerOrders]);
    }
}

2. Register your class to DI Container in di.yaml file if needed

containers:
    KejawenLab\SemartApiGateway\Aggregate:
        - 'Other\Service\Class'
        - 'staticParameter'

Just two simple step to create aggregate query handler, very simple, isn't it?