PHPackages                             rfpdl/whats-up-doc - 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. rfpdl/whats-up-doc

ActiveLibrary[API Development](/categories/api)

rfpdl/whats-up-doc
==================

Generate beautiful API documentation from Laravel Data DTOs

00PHP

Since Oct 6Pushed 7mo agoCompare

[ Source](https://github.com/rfpdl/whats-up-doc)[ Packagist](https://packagist.org/packages/rfpdl/whats-up-doc)[ RSS](/packages/rfpdl-whats-up-doc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

What's Up Doc
=============

[](#whats-up-doc)

Generate beautiful API documentation from your Laravel Data DTOs automatically.

Features
--------

[](#features)

- 🚀 **Zero Configuration** - Works out of the box
- 📊 **Multiple Formats** - HTML, JSON, OpenAPI
- 🎨 **Beautiful UI** - Clean, responsive documentation
- ⚡ **Fast Generation** - Scans and generates docs quickly
- 🔧 **Customizable** - Themes, colors, and branding
- 🛣️ **Route Integration** - Auto-detects API endpoints using Laravel Data
- 📋 **Request/Response Documentation** - Shows Data classes used in routes

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

[](#installation)

```
composer require rfpdl/whats-up-doc
```

Quick Start
-----------

[](#quick-start)

```
# Generate HTML documentation
php artisan data-doc:generate

# Generate JSON schema
php artisan data-doc:generate --format=json

# Generate OpenAPI specification
php artisan data-doc:generate --format=openapi

# Custom output directory
php artisan data-doc:generate --output=/path/to/docs
```

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

[](#configuration)

Publish the configuration file:

```
php artisan vendor:publish --provider="Rfpdl\WhatsUpDoc\WhatsUpDocServiceProvider" --tag="config"
```

### Configuration Options

[](#configuration-options)

```
return [
    'title' => 'My API Documentation',
    'description' => 'Generated from Laravel Data DTOs',
    'output_path' => storage_path('app/docs'),
    'scan_paths' => [
        app_path('Data'),
    ],
    'route_prefixes' => [
        'api/v1',
        'api',
    ],
    'routes' => [
        'enabled' => true,
        'include_middleware' => false,
        'group_by_prefix' => true,
    ],
    'template' => [
        'theme' => 'default',
        'primary_color' => '#3b82f6',
        'logo_url' => null,
    ],
];
```

Usage Example
-------------

[](#usage-example)

Given a Laravel Data class:

```