PHPackages                             laraswag/laravel-swagger-exporter - 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. laraswag/laravel-swagger-exporter

ActiveLibrary[API Development](/categories/api)

laraswag/laravel-swagger-exporter
=================================

A small Laravel package to export model-based Swagger YAML files and provide a simple Swagger UI view.

v1.0.0(3mo ago)03MITPHPPHP ^8.0

Since Feb 1Pushed 3mo agoCompare

[ Source](https://github.com/Eng-Mohannad-Mahmoud/laravel-swagger-exporter)[ Packagist](https://packagist.org/packages/laraswag/laravel-swagger-exporter)[ RSS](/packages/laraswag-laravel-swagger-exporter/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

Laraswag - Laravel Swagger Exporter
===================================

[](#laraswag---laravel-swagger-exporter)

[![Latest Version on Packagist](https://camo.githubusercontent.com/65b7e7f0931ee1e6575c9a32a84577d7c560f29ec0b21cd961a4bd18f62c1298/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6c617261737761672f6c61726176656c2d737761676765722d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/laraswag/laravel-swagger-exporter)[![License](https://camo.githubusercontent.com/4b29f48f705f408f2da48d84569ccfb64093f0ea9d64771c5dcb2a215dbc7eb7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6c617261737761672f6c61726176656c2d737761676765722d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![PHP Version](https://camo.githubusercontent.com/1c12ad520e54c3959ced01fe4cf765d187ba9b62642356fd71770f240fdb9d9f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6c617261737761672f6c61726176656c2d737761676765722d6578706f727465723f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/1c12ad520e54c3959ced01fe4cf765d187ba9b62642356fd71770f240fdb9d9f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6c617261737761672f6c61726176656c2d737761676765722d6578706f727465723f7374796c653d666c61742d737175617265)[![Laravel Version](https://camo.githubusercontent.com/5fecc1e190d1d048fa0f36a1b2e2ebc744ad53b61b026b1d42dc2c40570d0b72/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d382e782d2d31312e782d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](https://laravel.com)

Automatically generate Swagger/OpenAPI YAML documentation for your Eloquent models by analyzing routes and FormRequest validation rules.

Installation
------------

[](#installation)

```
composer require laraswag/laravel-swagger-exporter
```

The package auto-registers with Laravel 11+. For Laravel 10 and below, add the service provider to `config/app.php`:

```
'providers' => [
    // ...
    Laraswag\LaravelSwaggerExporter\ServiceProvider::class,
],
```

Quick Usage
-----------

[](#quick-usage)

### Generate Swagger Files

[](#generate-swagger-files)

```
# Export a single model
php artisan swagger:export --model=Post

# Or use FQCN
php artisan swagger:export --model=App\\Models\\Post

# Or Export all models
php artisan swagger:export --all
```

### View Documentation

[](#view-documentation)

Visit `/swagger` in your app to view all generated YAML files.

Features
--------

[](#features)

- **Automatic Documentation**: Analyzes routes and FormRequest validation to generate Swagger YAML
- **Built-in UI**: View generated docs at `/swagger`
- **Artisan Commands**: Easy model export via CLI
- **Configurable**: Customize output paths and routes via `config/laraswag.php`
- **DI Ready**: Use `ModelSwaggerExporter` service directly

Publishing Assets
-----------------

[](#publishing-assets)

```
# Publish public files
php artisan vendor:publish --provider="Laraswag\LaravelSwaggerExporter\ServiceProvider" --tag=laraswag-public

# Publish config
php artisan vendor:publish --provider="Laraswag\LaravelSwaggerExporter\ServiceProvider" --tag=laraswag-config

# Publish views for customization
php artisan vendor:publish --provider="Laraswag\LaravelSwaggerExporter\ServiceProvider" --tag=laraswag-views
```

Routes
------

[](#routes)

add these routes to api.php file

```
Route::get('/ping', fn () => response()->json(['message' => 'pong'], 200));
Route::middleware('auth:sanctum')->get('/ping-auth', fn () => response()->json(['message' => 'pong'], 200));
```

Configuration
-------------

[](#configuration)

Key options in `config/laraswag.php`:

```
'public_path' => public_path('swagger_ui/'), // Where YAML files are stored
'route_prefix' => 'swagger', // URL prefix for the UI
'middleware' => ['web'], // Middleware for Swagger routes
```

Requirements
------------

[](#requirements)

- PHP 8.0+
- Laravel 8.x, 9.x, 10.x, or 11.x

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance81

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

100d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6b2c2ab0cdadc040217871b9c6c2cc5a5affa0b0407c682b31d6d6de841386f6?d=identicon)[Mohannad-Mahmoud](/maintainers/Mohannad-Mahmoud)

---

Top Contributors

[![Eng-Mohannad-Mahmoud](https://avatars.githubusercontent.com/u/119735701?v=4)](https://github.com/Eng-Mohannad-Mahmoud "Eng-Mohannad-Mahmoud (1 commits)")

### Embed Badge

![Health badge](/badges/laraswag-laravel-swagger-exporter/health.svg)

```
[![Health](https://phpackages.com/badges/laraswag-laravel-swagger-exporter/health.svg)](https://phpackages.com/packages/laraswag-laravel-swagger-exporter)
```

###  Alternatives

[mollie/laravel-mollie

Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite

3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql

Easily integrate GraphiQL into your Laravel project

683.2M9](/packages/mll-lab-laravel-graphiql)[spatie/laravel-route-discovery

Auto register routes using PHP attributes

23645.0k2](/packages/spatie-laravel-route-discovery)[esign/laravel-conversions-api

A laravel wrapper package around the Facebook Conversions API

69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk

PHP SDK for DIDWW API 3

1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger

A Laravel package to create an ActivityPub webfinger.

113.8k](/packages/surface-laravel-webfinger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)