swagger deployed at /swagger

laravel/app/Providers/SwaggerUiServiceProvider.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\ServiceProvider;
+
+class SwaggerUiServiceProvider extends ServiceProvider
+{
+    public function boot() : void
+    {
+        Gate::define('viewSwaggerUI', function ($user = null) {
+            return in_array(optional($user)->email, [
+                //
+            ]);
+        });
+    }
+}

laravel/composer.json

@@ -9,7 +9,8 @@
         "php": "^8.2",
         "laravel/framework": "^12.0",
         "laravel/sanctum": "^4.0",
-        "laravel/tinker": "^2.10.1"
+        "laravel/tinker": "^2.10.1",
+        "wotz/laravel-swagger-ui": "^1.2"
     },
     "require-dev": {
         "fakerphp/faker": "^1.23",

laravel/composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "85c1d2065f70e38b0d6bf66559fb13c5",
+    "content-hash": "9ab0c2699b085b8f930df0cbb271b9a3",
     "packages": [
         {
             "name": "brick/math",
@@ -5842,6 +5842,75 @@
                 "source": "https://github.com/webmozarts/assert/tree/1.11.0"
             },
             "time": "2022-06-03T18:03:27+00:00"
+        },
+        {
+            "name": "wotz/laravel-swagger-ui",
+            "version": "1.2.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/wotzebra/laravel-swagger-ui.git",
+                "reference": "f63430e96179c919c521ebb76fc4dddcc8b3dfae"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/wotzebra/laravel-swagger-ui/zipball/f63430e96179c919c521ebb76fc4dddcc8b3dfae",
+                "reference": "f63430e96179c919c521ebb76fc4dddcc8b3dfae",
+                "shasum": ""
+            },
+            "require": {
+                "ext-json": "*",
+                "laravel/framework": "^9.0|^10.0|^11.0|^12.0",
+                "php": "^8.1|^8.2|^8.3|^8.4"
+            },
+            "require-dev": {
+                "adamwojs/php-cs-fixer-phpdoc-force-fqcn": "^2.0",
+                "friendsofphp/php-cs-fixer": "^3.0",
+                "guzzlehttp/guzzle": "^7.5",
+                "jasonmccreary/laravel-test-assertions": "^2.3",
+                "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0",
+                "phpunit/phpunit": "^9.5|^10.0|^11.5.3",
+                "squizlabs/php_codesniffer": "^3.6"
+            },
+            "suggest": {
+                "ext-yaml": "*"
+            },
+            "type": "library",
+            "extra": {
+                "laravel": {
+                    "providers": [
+                        "Wotz\\SwaggerUi\\SwaggerUiServiceProvider"
+                    ]
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Wotz\\SwaggerUi\\": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Günther Debrauwer",
+                    "email": "gunther.debrauwer@whoownsthezebra.be",
+                    "role": "Developer"
+                }
+            ],
+            "description": "Add Swagger UI to a Laravel application.",
+            "homepage": "https://github.com/wotzebra/laravel-swagger-ui",
+            "keywords": [
+                "laravel",
+                "openapi",
+                "swagger",
+                "swagger-ui"
+            ],
+            "support": {
+                "issues": "https://github.com/wotzebra/laravel-swagger-ui/issues",
+                "source": "https://github.com/wotzebra/laravel-swagger-ui/tree/1.2.0"
+            },
+            "time": "2025-03-05T09:26:18+00:00"
         }
     ],
     "packages-dev": [

laravel/config/swagger-ui.php

@@ -0,0 +1,72 @@
+<?php
+
+use Wotz\SwaggerUi\Http\Middleware\EnsureUserIsAuthorized;
+
+return [
+    'files' => [
+        [
+            /*
+             * The path where the swagger file is served.
+             */
+            'path' => 'swagger',
+
+            /*
+             * The title of the page where the swagger file is served.
+             */
+            'title' => env('APP_NAME') . ' - Swagger',
+
+            /*
+             * The versions of the swagger file. The key is the version name and the value is the path to the file.
+             */
+            'versions' => [
+                'v1' => resource_path('/swagger/openapi.json'),
+            ],
+
+            /*
+             * The default version that is loaded when the route is accessed.
+             */
+            'default' => 'v1',
+
+            /*
+             * The middleware that is applied to the route.
+             */
+            'middleware' => [
+                'web',
+                EnsureUserIsAuthorized::class,
+            ],
+
+            /*
+             * Specify the validator URL. Set to false to disable validation.
+             */
+            'validator_url' => false,
+
+            /*
+             * If enabled the file will be modified to set the server url and oauth urls.
+             */
+            'modify_file' => true,
+
+            /*
+             * The server URL configuration for the swagger file.
+             */
+            'server_url' => env('APP_URL'),
+
+            /*
+             * The oauth configuration for the swagger file.
+             */
+            'oauth' => [
+                'token_path' => 'oauth/token',
+                'refresh_path' => 'oauth/token',
+                'authorization_path' => 'oauth/authorize',
+
+                'client_id' => env('SWAGGER_UI_OAUTH_CLIENT_ID'),
+                'client_secret' => env('SWAGGER_UI_OAUTH_CLIENT_SECRET'),
+            ],
+
+            /*
+             * Path to a custom stylesheet file if you want to customize the look and feel of swagger-ui.
+             * The content of the file will be read and added into a style-tag on the swagger-ui page.
+             */
+            'stylesheet' => null,
+        ],
+    ],
+];

laravel/resources/swagger/openapi.json

@@ -0,0 +1,432 @@
+{
+  "openapi": "3.0.4",
+  "info": {
+    "title": "Blog API",
+    "description": "Projet Laravel avec Sanctum pour l'authentification",
+    "license": {
+      "name": "Creative Commons 4.0",
+      "url": "https://creativecommons.org/licenses/by/4.0/"
+    },
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://isi2.ale-pri.com/api/",
+      "description": "Serveur de production"
+    },
+    {
+      "url": "http://localhost:8000/api/",
+      "description": "Serveur de développement local"
+    }
+  ],
+  "tags": [
+    {
+      "name": "billets",
+      "description": "Opérations sur les billets"
+    },
+    {
+      "name": "commentaires",
+      "description": "Operations sur les commentaires"
+    },
+    {
+      "name": "user",
+      "description": "Operations about user"
+    }
+  ],
+  "paths": {
+    "/billets": {
+      "get": {
+        "tags": [
+          "billets"
+        ],
+        "summary": "Liste des billets",
+        "operationId": "getBillets",
+        "responses": {
+          "200": {
+            "description": "Liste des billets",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Billet"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/login": {
+      "post": {
+        "responses": {
+          "200": {
+            "description": "Authentification réussie",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TokenResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Authentification échouée"
+          }
+        },
+        "tags": [
+          "user"
+        ],
+        "summary": "Authentification de l'utilisateur",
+        "operationId": "loginUser",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/LoginRequest"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/register": {
+      "post": {
+        "responses": {
+          "201": {
+            "description": "Utilisateur créé avec succès",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TokenResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Erreur de validation"
+          }
+        },
+        "tags": [
+          "user"
+        ],
+        "summary": "Enregistrement d'un nouvel utilisateur",
+        "operationId": "registerUser",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RegisterRequest"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/user": {
+      "get": {
+        "security": [
+          {
+            "sanctum": []
+          }
+        ],
+        "tags": [
+          "user"
+        ],
+        "summary": "Récupérer les informations de l'utilisateur connecté",
+        "operationId": "getUser",
+        "responses": {
+          "200": {
+            "description": "Informations de l'utilisateur",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Non autorisé"
+          }
+        }
+      }
+    },
+    "/user/logout": {
+      "post": {
+        "security": [
+          {
+            "sanctum": []
+          }
+        ],
+        "tags": [
+          "user"
+        ],
+        "summary": "Déconnexion de l'utilisateur",
+        "operationId": "logoutUser",
+        "responses": {
+          "204": {
+            "description": "Déconnexion réussie"
+          },
+          "401": {
+            "description": "Non autorisé"
+          }
+        }
+      }
+    },
+    "/billets/{id}": {
+      "get": {
+        "security": [
+          {
+            "sanctum": []
+          }
+        ],
+        "tags": [
+          "billets"
+        ],
+        "summary": "Détails d'un billet",
+        "operationId": "getBilletById",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer"
+            },
+            "description": "ID du billet"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Détails du billet",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BilletWithComments"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Billet non trouvé"
+          }
+        }
+      }
+    },
+    "/commentaires": {
+      "post": {
+        "security": [
+          {
+            "sanctum": []
+          }
+        ],
+        "tags": [
+          "commentaires"
+        ],
+        "summary": "Ajouter un commentaire à un billet",
+        "operationId": "addComment",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CommentaireRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Commentaire ajouté avec succès",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Commentaire"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Erreur de validation"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Billet": {
+        "type": "object",
+        "properties": {
+          "Date": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2023-10-01"
+          },
+          "Titre": {
+            "type": "string",
+            "example": "Billet 1"
+          },
+          "Contenu": {
+            "type": "string",
+            "example": "Lorem ipsum dolor sit amet."
+          }
+        }
+      },
+      "BilletWithComments": {
+        "type": "object",
+        "properties": {
+          "Date": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2023-10-01"
+          },
+          "Titre": {
+            "type": "string",
+            "example": "Billet 1"
+          },
+          "Contenu": {
+            "type": "string",
+            "example": "Lorem ipsum dolor sit amet."
+          },
+          "Commentaires": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Commentaire"
+            }
+          }
+        }
+      },
+      "Commentaire": {
+        "type": "object",
+        "properties": {
+          "COM_DATE": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2023-10-01"
+          },
+          "COM_AUTEUR": {
+            "type": "string",
+            "example": "John Doe"
+          },
+          "COM_CONTENU": {
+            "type": "string",
+            "example": "Lorem ipsum dolor sit amet."
+          },
+          "billet_id": {
+            "type": "integer",
+            "example": 1
+          },
+          "user_id": {
+            "type": "integer",
+            "example": 1
+          }
+        }
+      },
+      "CommentaireRequest": {
+        "type": "object",
+        "properties": {
+          "COM_DATE": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2023-10-01"
+          },
+          "COM_CONTENU": {
+            "type": "string",
+            "example": "Lorem ipsum dolor sit amet."
+          },
+          "billet_id": {
+            "type": "integer",
+            "example": 1
+          },
+          "user_id": {
+            "type": "integer",
+            "example": 1
+          }
+        }
+      },
+      "LoginRequest": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "au@secou.rs"
+          },
+          "password": {
+            "type": "string",
+            "format": "password",
+            "example": "secret123"
+          }
+        }
+      },
+      "TokenResponse": {
+        "type": "object",
+        "properties": {
+          "token": {
+            "type": "string",
+            "example": "1|a2b3c4d5e6f7g8h9i0j"
+          },
+          "type": {
+            "type": "string",
+            "example": "Bearer"
+          }
+        }
+      },
+      "RegisterRequest": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "example": "John Doe"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "au@secou.rs"
+          },
+          "password": {
+            "type": "string",
+            "format": "password",
+            "example": "secret123"
+          }
+        }
+      },
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "example": 1
+          },
+          "name": {
+            "type": "string",
+            "example": "John Doe"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "au@secou.rs"
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "sanctum": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "Bearer",
+        "description": "Utiliser le token Bearer pour l'authentification"
+      }
+    }
+  }
+}