README

foundation-api est une collection de class pour faciliter la création et l'utilisation d'une APIA avec le framework Slim v4

Installation

composer require fzed51/foundation-api

Utilisation

App Factory

C'est une class static qui a la méthode create qui prend en paramètre un tableau de settings

settings

<?php
return [
    "logger" => [
        "name" => "nom du projet", // [obligatoire] necessaire pour les logs multi projets
        "path" => "chemin/vers/dossier/de/log"
    ]
];

L'exemple ci-dessus est le strict minimum pour les settings de l'app

create

<?php
$settings = [...];
$app = \Api\Factory::create($settings);

Les Middleware

Pour créer un middleware utiliser la class \Api\MiddleWare et implémenter la methode __invoke.

⚠️Ne pas modifier la signature du contructeur

exemple :

class SampleMiddleware extends \Api\Middleware
{
    /**
     * @inheritDoc
     */
    public function __invoke(Request $request, RequestHandler $handler): Response
    {
        // Faire qqchose avant le process
        $response $handler->handle($request);
        // Faire qqchose après le process
        return $response;
    }

unofficialmc2 / foundation-api

Maintainers

Details