unofficialmc2/foundation-api

Package contenant un ensemble de class permettant de construire un API avec Slim v4

v3.4.2 2024-09-27 12:55 UTC

Requires

• php: ^8.3
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• ext-openssl: *
• ext-pdo: *
• monolog/monolog: ^3.2
• pimple/pimple: ^3.5
• slim/http: ^1.2
• slim/psr7: ^1.5
• slim/slim: ^4.10
• unofficialmc2/http-exception: ^3.0
• unofficialmc2/instance-resolver: ^2.0
• unofficialmc2/migration: ^2.0
• unofficialmc2/pdo-helper: ^2.0
• unofficialmc2/respect-validation-wrapper: ^4.0

Requires (Dev)

• fakerphp/faker: ^1.20
• ocramius/package-versions: ^2.6
• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^11.3
• squizlabs/php_codesniffer: ^3.7

Suggests

• firebase/php-jwt: pour la gestion des JWT
• phpmailer/phpmailer: pour les envois d'e-mail

MIT

• Fabien Sanchez

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;
    }