Download the PHP package bamagid/laraswagger without Composer
On this page you can find all versions of the php package bamagid/laraswagger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laraswagger
bamagid/laraswagger
🌍 Documentation Multilingue
FRANÇAIS
ENGLISH
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
- 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
⚙️ 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.
🛠️ Usage
Adding Descriptions to Endpoints
To document an endpoint, use a @summary comment above the corresponding function:
Environment Variable
Control real-time documentation updates with the AUTO_GENERATE_DOCS environment variable:
true(default): Real-time documentation updatesfalse: Manual documentation generation
Add to your .env file:
Command
When AUTO_GENERATE_DOCS is set to false, generate documentation using:
Accessing the Documentation
The generated Swagger documentation is available at the following route:
FRANÇAIS
Introduction
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
- 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
⚙️ Configuration
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.
🛠️ Utilisation
Description des endpoints
Variable d'environnement
Commande
Accéder à la Documentation
La documentation Swagger générée est disponible à l'adresse suivante :
All versions of laraswagger with dependencies
laravel/framework Version ^11.0 || ^10.0 || ^9.0 || >=8.40.0 || ^7.0
swagger-api/swagger-ui Version ^3.0 || >=4.1.3