PHPackages bamagid/laraswagger - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. bamagid/laraswagger ActiveLibrary[API Development](/categories/api) bamagid/laraswagger =================== v1.0.6(1y ago)10420MITPHPPHP ^7.2 || ^8.0 Since Jan 19Pushed 1mo ago1 watchersCompare [ Source](https://github.com/bamagid/Laraswager)[ Packagist](https://packagist.org/packages/bamagid/laraswagger)[ RSS](/packages/bamagid-laraswagger/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (2)Versions (9)Used By (0) bamagid/laraswagger =================== [](#bamagidlaraswagger) 🌍 Documentation Multilingue --------------------------- [](#-documentation-multilingue) [ENGLISH](#english) | [FRANÇAIS](#fran%C3%A7ais) ENGLISH ------- [](#english) Introduction ------------ [](#introduction) `bamagid/laraswagger` is a Laravel package designed to automate the generation of Swagger documentation. Once installed, it requires no additional configuration. This package ensures that your API documentation is always up to date with minimal effort. ### 🎉 Features [](#-features) - **Automatic Documentation**: Generate API documentation seamlessly without running extra commands - **Customizable Descriptions**: Add custom descriptions to your endpoints via comments - **Real-time Updates**: Keep your documentation updated in real-time (default behavior) ### 📦 Installation [](#-installation) ``` composer require bamagid/laraswagger ``` ### ⚙️ Configuration [](#️-configuration) No additional setup is required post-installation. The package works out of the box. However, if you'd like to customize the title or description of your API in the Swagger documentation, you can do so by editing the .env file. ``` APP_NAME: The title of your API APP_DESCRIPTION: The description of your APP ``` ### 🛠️ Usage [](#️-usage) #### Adding Descriptions to Endpoints [](#adding-descriptions-to-endpoints) To document an endpoint, use a @summary comment above the corresponding function: ``` /** * @summary This endpoint performs a specific action * Additional comments can go here. */ public function exampleFunction() { // Your code } ``` #### Environment Variable [](#environment-variable) Control real-time documentation updates with the `AUTO_GENERATE_DOCS` environment variable: - `true` (default): Real-time documentation updates - `false`: Manual documentation generation Add to your .env file: ``` AUTO_GENERATE_DOCS=true ``` #### Command [](#command) When `AUTO_GENERATE_DOCS` is set to false, generate documentation using: ``` php artisan swagger:generate ``` #### Accessing the Documentation [](#accessing-the-documentation) The generated Swagger documentation is available at the following route: ``` /api/documentation ``` FRANÇAIS -------- [](#français) Introduction ------------ [](#introduction-1) `bamagid/laraswagger` est un package Laravel conçu pour automatiser la génération de documentation Swagger. Une fois installé, il ne nécessite aucune configuration supplémentaire. Ce package garantit que votre documentation API reste toujours à jour avec un minimum d'effort. ### 🎉 Fonctionnalités [](#-fonctionnalités) - **Documentation automatique** : Génération de documentation API sans commandes supplémentaires - **Descriptions personnalisables** : Ajout de descriptions aux endpoints via commentaires - **Mises à jour en temps réel** : Documentation automatiquement mise à jour (par défaut) ### 📦 Installation [](#-installation-1) ``` composer require bamagid/laraswagger ``` ### ⚙️ Configuration [](#️-configuration-1) Aucune configuration supplémentaire requise après l'installation. Si vous souhaitez personnaliser le titre ou la description de votre API dans la documentation Swagger, vous pouvez le faire en modifiant votre fichier .env. ``` APP_NAME: The title of your API APP_DESCRIPTION: The description of your APP ``` ### 🛠️ Utilisation [](#️-utilisation) #### Description des endpoints [](#description-des-endpoints) ``` /** * @summary Cet endpoint exécute une action spécifique * D'autres commentaires peuvent être ajoutés ici. */ public function exempleFunction() { // Votre code } ``` #### Variable d'environnement [](#variable-denvironnement) ``` AUTO_GENERATE_DOCS=true ``` #### Commande [](#commande) ``` php artisan swagger:generate ``` #### Accéder à la Documentation [](#accéder-à-la-documentation) La documentation Swagger générée est disponible à l'adresse suivante : ``` /api/documentation ``` ### Health Score 40 — FairBetter than 88% of packages Maintenance71 Regular maintenance activity Popularity23 Limited adoption so far Community9 Small or concentrated contributor base Maturity48 Maturing project, gaining track record Bus Factor1 Top contributor holds 70% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~16 days Recently: every ~24 days Total 7 Last Release 377d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/0da3462b51b4c9527948d6b4d61873605d3c174f6f6259624de595a9475efb31?d=identicon)[bamagid](/maintainers/bamagid) --- Top Contributors [![magid-ba](https://avatars.githubusercontent.com/u/176605801?v=4)](https://github.com/magid-ba "magid-ba (14 commits)")[![bamagid](https://avatars.githubusercontent.com/u/81322603?v=4)](https://github.com/bamagid "bamagid (6 commits)") --- Tags apilaraveldocumentationuiswaggeropenapiswagger-uilaraswagger ### Embed Badge ![Health badge](/badges/bamagid-laraswagger/health.svg) ``` [![Health](https://phpackages.com/badges/bamagid-laraswagger/health.svg)](https://phpackages.com/packages/bamagid-laraswagger) ``` ### Alternatives [darkaonline/l5-swagger OpenApi or Swagger integration to Laravel 2.9k34.0M112](/packages/darkaonline-l5-swagger)[swagger-api/swagger-ui Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API. 28.7k45.4M99](/packages/swagger-api-swagger-ui)[darkaonline/swagger-lume OpenApi or Swagger integration to Lumen 3372.3M3](/packages/darkaonline-swagger-lume)[johnylemon/laravel-apidocs Laravel API documentation generating tool 472.8k](/packages/johnylemon-laravel-apidocs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)