PHPackages edrisaturay/filament-api-docs-builder - 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. edrisaturay/filament-api-docs-builder ActiveLibrary[API Development](/categories/api) edrisaturay/filament-api-docs-builder ===================================== This package will give you the best API docs building experience. 2.1.0(5mo ago)053MITPHPPHP ^8.2 Since Jan 23Pushed 2mo agoCompare [ Source](https://github.com/edrisaturay/filament-api-docs)[ Packagist](https://packagist.org/packages/edrisaturay/filament-api-docs-builder)[ Docs](https://github.com/edrisaturay/filament-api-docs)[ RSS](/packages/edrisaturay-filament-api-docs-builder/feed)WikiDiscussions main Synced 3w ago READMEChangelogDependencies (9)Versions (2)Used By (0) [![Filament API Docs Builder](image.png)](image.png) Filament Api Docs Builder ========================= [](#filament-api-docs-builder) [![Latest Version on Packagist](https://camo.githubusercontent.com/50047e5ee42165f3930a7470037507d51a2449cf6773d88e3a519569b4a99b0d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f65647269736174757261792f66696c616d656e742d6170692d646f63732d6275696c6465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/edrisaturay/filament-api-docs-builder)[![GitHub Tests Action Status](https://camo.githubusercontent.com/54bff6b39451fc7ff0f41649f9ed1fb54fd57f2b397312717815baa263a70cc6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f65647269736174757261792f66696c616d656e742d6170692d646f63732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/edrisaturay/filament-api-docs/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/3814b32360fe3aab7090f86ee56dbeb0d1bfbb9f9b8990582c2056338fe7a1ba/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f65647269736174757261792f66696c616d656e742d6170692d646f63732f6669782d7068702d636f64652d7374796c696e672e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/edrisaturay/filament-api-docs/actions?query=workflow%3A%22Fix+PHP+code+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/cba6a3770a59a63706b710a35909dd5fe90314e55cb556d22441d8e6e0633259/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f65647269736174757261792f66696c616d656e742d6170692d646f63732d6275696c6465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/edrisaturay/filament-api-docs-builder) This package allows you to build a good looking and functional api documentation. Including exporting and importing actions with postman standard. Requirements ------------ [](#requirements) - PHP 8.2+ - **Filament v4 or v5** (`^4.0|^5.0`) - For Filament v4: Laravel 10.x or 11.x, Livewire v3 - For Filament v5: Laravel 11.28+, Livewire v4 Installation ------------ [](#installation) Since this package is currently in development and depends on newer Laravel components, you should install it with the `dev-main` constraint: ``` composer require edrisaturay/filament-api-docs-builder:dev-main ``` You can install the package with: ``` php artisan filament-api-docs-builder:install ``` Also you need to add a source to your custom theme: ``` @source '/vendor/edrisaturay/filament-api-docs-builder/resources/views/filament/**/*'; ``` Otherwise you can publish and run the migrations with: ``` php artisan vendor:publish --tag="filament-api-docs-builder-migrations" php artisan migrate ``` You can publish the config file with: ``` php artisan vendor:publish --tag="filament-api-docs-builder-config" ``` Optionally, you can publish the views using ``` php artisan vendor:publish --tag="filament-api-docs-builder-views" ``` Usage ----- [](#usage) You can use this package by registering the plugin inside you filament service provider. ``` ->plugin(EdrisaTuray\FilamentApiDocsBuilder\FilamentApiDocsBuilderPlugin::make()) ``` Otherwise you can make your own resource and `ApiDocsFormBuilder` for form generation. ``` use EdrisaTuray\FilamentApiDocsBuilder\Filament\Forms\ApiDocsFormBuilder; public static function getModel(): string { return config('filament-api-docs-builder.model'); } public static function form(Form $form): Form { return $form->schema(ApiDocsFormBuilder::make()); } ``` And `ApiDocsInfolistBuilder` for infolist generation. ``` use EdrisaTuray\FilamentApiDocsBuilder\Filament\Infolists\ApiDocsInfolistBuilder; public static function getResource(): string { return config('filament-api-docs-builder.resource'); } public function infolist(Infolist $infolist): Infolist { $record = $this->getRecord(); $this->heading = '[v' . $record->version . '] ' . $record->title; $this->subheading = $record->description; return $infolist->schema(ApiDocsInfolistBuilder::make($record)); } ``` There are also two actions for export and import docs with postman json standard. ``` use EdrisaTuray\FilamentApiDocsBuilder\Filament\Actions\CollectionDownloaderAction; use EdrisaTuray\FilamentApiDocsBuilder\Filament\Actions\CollectionImporterAction; protected function getHeaderActions(): array { return [ CollectionDownloaderAction::make('downloader'), CollectionImporterAction::make('importer'), ]; } ``` This package includes various different code builders but you can add your own in config `code_builders` array. You can also predefine your enpoint parameter in config `predefined_params` array. \[Check config for more details\] If you are using multi tenancy you need to set your tenant model class in config with method `getTenant`. If you want to use infolist publicly, just make a public filament page and pass in infolist. Screenshots ----------- [](#screenshots) [![image](https://private-user-images.githubusercontent.com/100382372/384928616-e8183f56-a001-48ba-8127-74a6478c9bcb.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4NjE2LWU4MTgzZjU2LWEwMDEtNDhiYS04MTI3LTc0YTY0NzhjOWJjYi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT03YTA3MDlmNmVhYTFjOGE4NzRmMTViZmU0Mzg2OGFjMDQyMDdkYmZhYTMxZTY5NmY0YzQ0NzQ4N2MyYTg5NjE0JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.mG-yOaq36EO7mbkrKFSOs9lekvmeN01dEmHijWDr5N4)](https://private-user-images.githubusercontent.com/100382372/384928616-e8183f56-a001-48ba-8127-74a6478c9bcb.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4NjE2LWU4MTgzZjU2LWEwMDEtNDhiYS04MTI3LTc0YTY0NzhjOWJjYi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT03YTA3MDlmNmVhYTFjOGE4NzRmMTViZmU0Mzg2OGFjMDQyMDdkYmZhYTMxZTY5NmY0YzQ0NzQ4N2MyYTg5NjE0JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.mG-yOaq36EO7mbkrKFSOs9lekvmeN01dEmHijWDr5N4)[![image](https://private-user-images.githubusercontent.com/100382372/384928867-fbee6f2e-1dec-4487-9cc0-05e659170f3d.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4ODY3LWZiZWU2ZjJlLTFkZWMtNDQ4Ny05Y2MwLTA1ZTY1OTE3MGYzZC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mNjFkYWIyMDdkN2Q3NGIyMjI1YmUxNDA4MjM4Y2UzMmY5NjhiOGFlN2UxYmU1NTEzMDkzNGY1NDhlZDVkOGRjJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.1VGv-rHxi3if6VyNpK1M1p4U3RVYtSf-JK6Us8nAtSg)](https://private-user-images.githubusercontent.com/100382372/384928867-fbee6f2e-1dec-4487-9cc0-05e659170f3d.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4ODY3LWZiZWU2ZjJlLTFkZWMtNDQ4Ny05Y2MwLTA1ZTY1OTE3MGYzZC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mNjFkYWIyMDdkN2Q3NGIyMjI1YmUxNDA4MjM4Y2UzMmY5NjhiOGFlN2UxYmU1NTEzMDkzNGY1NDhlZDVkOGRjJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.1VGv-rHxi3if6VyNpK1M1p4U3RVYtSf-JK6Us8nAtSg)[![image](https://private-user-images.githubusercontent.com/100382372/384938540-ae1f621e-0b31-4c62-9fb3-3a85b1942346.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTM4NTQwLWFlMWY2MjFlLTBiMzEtNGM2Mi05ZmIzLTNhODViMTk0MjM0Ni5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mYmI5MTYxNjFmMDFhNGRkMThmYjU3NGQyN2I0ZDM5MTI1YjdhZmZlZTc3MmU3OWUwMDBiZTRkZDA0ZmI1MmEyJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.Jsz1hWO9zhGq_gYvzh6WufIDBAFPKRnnyh9RwK_W8CA)](https://private-user-images.githubusercontent.com/100382372/384938540-ae1f621e-0b31-4c62-9fb3-3a85b1942346.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODA5NjcyMTUsIm5iZiI6MTc4MDk2NjkxNSwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTM4NTQwLWFlMWY2MjFlLTBiMzEtNGM2Mi05ZmIzLTNhODViMTk0MjM0Ni5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNjA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDYwOVQwMTAxNTVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mYmI5MTYxNjFmMDFhNGRkMThmYjU3NGQyN2I0ZDM5MTI1YjdhZmZlZTc3MmU3OWUwMDBiZTRkZDA0ZmI1MmEyJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.Jsz1hWO9zhGq_gYvzh6WufIDBAFPKRnnyh9RwK_W8CA) Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - **Original Author**: [ZPMLabs](https://github.com/zpmlabs) - Original `zpmlabs/filament-api-docs-builder` package - **Maintainer**: [Edrisa Turay](https://github.com/edrisaturay) - [All Contributors](../../contributors) License ------- [](#license) MIT License. Please see [License File](LICENSE.md) for more information. This package is a fork and rebrand of the original `zpmlabs/filament-api-docs-builder` package. The original package was proprietary licensed. This fork is released under the MIT License with proper attribution to the original author. ### Health Score 37 — LowBetter than 81% of packages Maintenance79 Regular maintenance activity Popularity8 Limited adoption so far Community8 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 68.8% 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 152d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/95329b757401f7d19594b60cf196fef575ef365863207549dd320a28d03172e7?d=identicon)[edrisaa.turay](/maintainers/edrisaa.turay) --- Top Contributors [![edrisaturay](https://avatars.githubusercontent.com/u/21174548?v=4)](https://github.com/edrisaturay "edrisaturay (11 commits)")[![sasaorasanin](https://avatars.githubusercontent.com/u/100382372?v=4)](https://github.com/sasaorasanin "sasaorasanin (5 commits)") --- Tags laravelfilament-api-docs-builderedrisaturay ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/edrisaturay-filament-api-docs-builder/health.svg) ``` [![Health](https://phpackages.com/badges/edrisaturay-filament-api-docs-builder/health.svg)](https://phpackages.com/packages/edrisaturay-filament-api-docs-builder) ``` ### Alternatives [rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3913.7k](/packages/rawilk-profile-filament-plugin)[stephenjude/filament-feature-flags Filament implementation of feature flags and segmentation with Laravel Pennant. 122157.7k1](/packages/stephenjude-filament-feature-flags)[stephenjude/filament-jetstream A Laravel starter kit built with Filament inspired by Jetstream. 17758.9k2](/packages/stephenjude-filament-jetstream)[zpmlabs/filament-api-docs-builder This package will give you the best API docs building experience. 152.2k](/packages/zpmlabs-filament-api-docs-builder)[stephenjude/filament-debugger About 104150.5k2](/packages/stephenjude-filament-debugger)[stephenjude/filament-two-factor-authentication Filament Two Factor Authentication: Google 2FA + Passkey Authentication 84192.9k8](/packages/stephenjude-filament-two-factor-authentication) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)