Guida

API

Endpoint tramite provider API, contratto JSON chiaro e regole di accesso in `Api.yaml`.

Registra gli endpoint tramite provider

Registra gli endpoint API dell’applicazione tramite ApiEndpointProviderInterface, non tramite il routing frontend. In questo modo la registrazione rimane allineata con OpenAPI e l’autorizzazione API.

example.php
<?php

declare(strict_types=1);

namespace App\Api;

use Lemonade\Framework\Api\Endpoint\ApiAccess;
use Lemonade\Framework\Api\Endpoint\ApiEndpointProviderInterface;
use Lemonade\Framework\Api\Endpoint\ApiEndpointRegistry;

final class AppApiEndpointProvider implements ApiEndpointProviderInterface
{
    public function register(ApiEndpointRegistry $registry): void
    {
        $registry->get(
            '/articles',
            'App\\Controllers\\Api\\ArticleController@index',
            'articles.index',
            'List articles',
            'Returns published articles.',
            ApiAccess::Public,
        );
    }
}

Restituisci JSON prevedibile

Mantieni esplicita la forma della response. Valida l’input prima di costruire il payload e usa json() con un contratto chiaro e stabile.

example.php
return $this->json([
    'ok' => true,
    'data' => [
        'id' => $article['id'],
        'title' => $article['title'],
    ],
]);

Proteggi un endpoint

Le regole di accesso API appartengono a app/Config/Api.yaml. Usa bearer scopes per gli endpoint protetti e consenti accesso pubblico solo dove è realmente previsto.

example.php
module: api
config:
  enabled: true
  prefix: /api
  security:
    static_bearer:
      enabled: true
      token:
        $env: API_TOKEN
        type: string
      scopes:
        - api:admin