PHPackages                             alexkramse/filament-openapi-docs - 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. alexkramse/filament-openapi-docs

ActiveLibrary

alexkramse/filament-openapi-docs
================================

Render Scramble OpenAPI documentation inside a Filament panel.

v0.7.0(yesterday)00MITPHP ^8.3

Since Jul 19Compare

[ Source](https://github.com/alexkramse/filament-openapi-docs)[ Packagist](https://packagist.org/packages/alexkramse/filament-openapi-docs)[ RSS](/packages/alexkramse-filament-openapi-docs/feed)WikiDiscussions Synced today

READMEChangelog (10)Dependencies (10)Versions (3)Used By (0)

Filament OpenAPI Docs
=====================

[](#filament-openapi-docs)

[![Tests](https://camo.githubusercontent.com/d940ad7f0752e2cbe0d63c50dcebf329078807390051c41fe63258f1b5c4e182/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d70617373696e672d627269676874677265656e)](https://camo.githubusercontent.com/d940ad7f0752e2cbe0d63c50dcebf329078807390051c41fe63258f1b5c4e182/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d70617373696e672d627269676874677265656e)[![Latest Stable Version](https://camo.githubusercontent.com/f710f6c4bdb0ab1fa669502ef8e7c8c4abd4c180dbe7931188a8efa055752b56/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c65786b72616d73652f66696c616d656e742d6f70656e6170692d646f63732e7376673f6c6162656c3d737461626c65)](https://camo.githubusercontent.com/f710f6c4bdb0ab1fa669502ef8e7c8c4abd4c180dbe7931188a8efa055752b56/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c65786b72616d73652f66696c616d656e742d6f70656e6170692d646f63732e7376673f6c6162656c3d737461626c65)[![License](https://camo.githubusercontent.com/f8df3091bbe1149f398a5369b2c39e896766f9f6efba3477c63e9b4aa940ef14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e)](https://camo.githubusercontent.com/f8df3091bbe1149f398a5369b2c39e896766f9f6efba3477c63e9b4aa940ef14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e)

Native OpenAPI documentation for Filament panels, powered by Scramble.

Filament OpenAPI Docs adds a dashboard page to your Filament panel where authenticated dashboard users can browse your generated OpenAPI specification, inspect endpoints, view request examples, and test API calls without leaving the admin area.

Features
--------

[](#features)

- Adds a native Filament page inside your existing panel navigation.
- Reads the generated OpenAPI document from Scramble by default.
- Groups endpoints in Filament sub-navigation for fast browsing.
- Shows endpoint methods, paths, parameters, request bodies, responses, schemas, and examples.
- Generates request samples for multiple languages and clients.
- Lets users test API endpoints directly from the dashboard.
- Provides configurable developer mode for custom request headers and query parameters.
- Supports panel-level fluent configuration and a publishable config file.
- Registers package CSS and JavaScript through Filament's asset manager.

Screenshots
-----------

[](#screenshots)

Filament-native OpenAPI docs page with endpoint navigation, request documentation, request samples, and responses.

[![Filament OpenAPI docs page](docs/images/filament-openapi-docs-page.png)](docs/images/filament-openapi-docs-page.png)More screenshots are available in [docs/screenshots.md](docs/screenshots.md).

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

[](#requirements)

- PHP `^8.3`
- Laravel `^13.0`
- Filament `^5.0`
- `dedoc/scramble` `^0.13.30`

This package currently requires [`dedoc/scramble`](https://scramble.dedoc.co/) and is tested only with Scramble-generated OpenAPI documents. Scramble is installed as a package dependency, but your Laravel application still needs a working Scramble configuration so the OpenAPI document can be generated correctly.

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

[](#installation)

Install the package with Composer:

```
composer require alexkramse/filament-openapi-docs
```

Publish Filament assets so the package CSS and async Alpine component are available in the browser:

```
php artisan filament:assets
```

You should also run `php artisan filament:assets` after package updates and during deployment if your application does not already run Filament's asset upgrade command automatically.

Register The Plugin
-------------------

[](#register-the-plugin)

Register the plugin in the Filament panel where the API documentation should appear:

```