Intégrez l'interface utilisateur Swagger à Codeigniter4

Swagger est un outil de documentation et de test d'API largement utilisé qui s'intègre de manière transparente aux frameworks Web populaires tels que Laravel, Spring Boot, CodeIgniter et ExpressJS. Dans cet article, nous nous concentrerons sur l'intégration de Swagger avec CodeIgniter.

Installation des dépendances :

composer require zircote/swagger-php doctrine/annotations

Téléchargement du dépôt SwaggerUI .zip ou SwaggerUI GitHub :

• Lien de téléchargement : dernières versions de SwaggerUI Téléchargez la version de l'interface utilisateur Swagger qui correspond le mieux à vos besoins.

Écriture du contrôleur :

Pour générer le fichier swagger.json pour Swagger UI, nous devrons créer un contrôleur. Nommez le contrôleur selon votre choix, nous lui donnons SwaggerDocGenerator.php. Dans le contrôleur, nous devrons utiliser OpenApiGenerator de zircote/swagger-php pour convertir toute la syntaxe @OA en JSON.

<?php namespace App\Controllers;

use OpenApi\Generator;

class SwaggerDocGenerator extends BaseController
{
    /**
     * Generate OpenAPI documentation for the API ...
     * @return string
     */
    public function generate(): string
    {
        // Specify the path where your API controllers are located
        $openapi = Generator::scan([APPPATH . 'Controllers']);

        $swaggerContent = $openapi->toJson();

        // Save the generated OpenAPI content to a file
        $filePath = FCPATH . 'swagger_ui/swagger.json';
        file_put_contents($filePath, $swaggerContent);

        return $swaggerContent;
    }

    /**
     * Render the SwaggerUI ...
     * @return string
     */
    public function index()
    {
        return view('swagger_docs/index');
    }
}

?>

Création d'itinéraires :

En créant une route sur Config/Routes.php nous pourrons générer le fichier sawgger.json attendu.

// Create API documentation ...
$routes->get('api/v1/docs/generate', 'SwaggerDocGenerator::generate');
$routes->get('api/v1/docs/ui', 'SwaggerDocGenerator::index');

Rendu de l'interface utilisateur Swagger :

Il existe de nombreuses façons de restituer votre fichier swagger.json dans SwaggerUI :

• Importation du fichier swagger.json dans le POSTMAN.
• Utiliser SwaggerUI avec vos propres vues pour restituer SwaggerUI.
• Configuration de l'environnement dans votre application frontend pour afficher SwaggerUI en demandant à l'API backend le fichier swagger.json.

En cela, nous verrons les deux premières manières. Nous parlerons de la 3ème voie dans un autre article.

Importation du fichier swagger.json dans POSTMAN :

• Copiez le swagger.json.
• Ouvrez le FACTEUR.
• Cliquez sur le bouton Importer dans le coin supérieur gauche.
• Collez le swagger.json copié.

Utilisation de SwaggerUI avec vos propres vues pour afficher SwaggerUI :

• Créez un fichier .php dans votre dossier de vues app/Views/swagger_docs/index.php pour afficher SwaggerUI.
• Extrayez le fichier SwaggerUI .zip téléchargé dans le dossier public/swagger_ui/.

composer require zircote/swagger-php doctrine/annotations

Note:

• Assurez-vous d'exécuter la commande php spark serve pour exécuter l'application Codeigniter4.
• Chaque fois que vous apportez des modifications à la syntaxe de la documentation OpenAPI, vous devrez exécuter l'URL http://localhost:8080/api/v1/docs/generate pour générer le fichier swagger.json mis à jour.
• Assurez-vous de mettre à jour le fichier swagger-initializer.js avec l'URL mise à jour du fichier swagger.json.

Conclusion:

Dans cet article, nous avons exploré l'intégration de Swagger avec CodeIgniter 4, la génération du fichier swagger.json, son rendu dans l'interface utilisateur Swagger et son importation dans Postman. Nous avons également montré comment afficher l'interface utilisateur Swagger dans des vues personnalisées. Cependant, générer manuellement le fichier swagger.json et mettre à jour l'URL dans le fichier swagger-initializer.js n'est pas idéal.

Dans le prochain article, je démontrerai l'automatisation de ce processus à l'aide de commandes CLI personnalisées et viserai à développer un package open source à cet effet. N'hésitez pas à partager vos suggestions ou questions dans la section commentaires.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!