Guide

API

Endpoints via des providers API, contrat JSON clair et règles d’accès dans `Api.yaml`.

Enregistrer les endpoints via des providers

Enregistrez les endpoints API de l’application via ApiEndpointProviderInterface, pas via le routing frontend. L’enregistrement reste ainsi cohérent avec OpenAPI et l’autorisation 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,
        );
    }
}

Retourner un JSON prévisible

Gardez la forme de la response explicite. Validez l’entrée avant de construire le payload et utilisez json() avec un contrat clair et stable.

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

Protéger un endpoint

Les règles d’accès API appartiennent à app/Config/Api.yaml. Utilisez des bearer scopes pour les endpoints protégés et n’autorisez l’accès public que lorsqu’il est réellement voulu.

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