PHPackages zpmlabs/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. zpmlabs/filament-api-docs-builder ActiveLibrary[API Development](/categories/api) zpmlabs/filament-api-docs-builder ================================= This package will give you the best API docs building experience. v3.0.2(2mo ago)151.9k↓48.3%3proprietaryPHPPHP ^8.2 Since Nov 11Pushed 2mo ago1 watchersCompare [ Source](https://github.com/zpm-packages/filament-api-docs)[ Packagist](https://packagist.org/packages/zpmlabs/filament-api-docs-builder)[ Docs](https://github.com/zpmlabs/filament-api-docs-builder)[ RSS](/packages/zpmlabs-filament-api-docs-builder/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (4)Dependencies (18)Versions (6)Used By (0) [![image](https://private-user-images.githubusercontent.com/100382372/451881807-d3ba9e91-6998-4a8c-b815-eacb0729c3a8.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvNDUxODgxODA3LWQzYmE5ZTkxLTY5OTgtNGE4Yy1iODE1LWVhY2IwNzI5YzNhOC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0xNGZjOGE1MmMwZDQyNWFiMDdkNTNkZWI0NjRkY2JkOWY1NjFhMDczM2VjNGJhYzUyNGNmMTMzZmNiZDRmZmFjJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.nyHl6YFFkyNE4o8ssMSvJnhf9Fru_q4JGMMfGAZX9oc)](https://private-user-images.githubusercontent.com/100382372/451881807-d3ba9e91-6998-4a8c-b815-eacb0729c3a8.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvNDUxODgxODA3LWQzYmE5ZTkxLTY5OTgtNGE4Yy1iODE1LWVhY2IwNzI5YzNhOC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0xNGZjOGE1MmMwZDQyNWFiMDdkNTNkZWI0NjRkY2JkOWY1NjFhMDczM2VjNGJhYzUyNGNmMTMzZmNiZDRmZmFjJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.nyHl6YFFkyNE4o8ssMSvJnhf9Fru_q4JGMMfGAZX9oc) Filament Api Docs Builder ========================= [](#filament-api-docs-builder) [![Latest Version on Packagist](https://camo.githubusercontent.com/627aab98d6cde495887cf9bbab2a7d1fe80e976c2705ac179e5bd70f4a471b62/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7a706d6c6162732f66696c616d656e742d6170692d646f63732d6275696c6465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/zpmlabs/filament-api-docs-builder)[![GitHub Tests Action Status](https://camo.githubusercontent.com/021cb6afdeaaece22e5cd4583eac29f83e08e55d766b29a619d33a8b795740f8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7a706d6c6162732f66696c616d656e742d6170692d646f63732d6275696c6465722f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/zpmlabs/filament-api-docs-builder/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/1c0e9ce84742cd6bb74b2d4025cd08e338a6eb6ca8320d69901d9ebf2f073781/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7a706d6c6162732f66696c616d656e742d6170692d646f63732d6275696c6465722f6669782d7068702d636f64652d7374796c696e672e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/zpmlabs/filament-api-docs-builder/actions?query=workflow%3A%22Fix+PHP+code+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/00adfa35bb3467f9d83d56000251eeb1b785321c969372d3ccfdec1231df85b1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7a706d6c6162732f66696c616d656e742d6170692d646f63732d6275696c6465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/zpmlabs/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. Installation ------------ [](#installation) You can install the package via composer repositories: ``` composer require zpmlabs/filament-api-docs-builder ``` 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/zpmlabs/filament-api-docs-builder/resources/views/filament/**/*'; @source '/vendor/guava/filament-icon-picker/resources/**/*'; ``` Since we are using [Guava Icon Picker](https://filamentphp.com/plugins/guava-icon-picker), you can get error on loading multiple icons too fast. So check their docs for that... 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(ZPMLabs\FilamentApiDocsBuilder\FilamentApiDocsBuilderPlugin::make()) ``` Otherwise you can make your own resource and `ApiDocsFormBuilder` for form generation. ``` use ZPMLabs\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 ZPMLabs\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 ZPMLabs\FilamentApiDocsBuilder\Filament\Actions\CollectionDownloaderAction; use ZPMLabs\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.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4NjE2LWU4MTgzZjU2LWEwMDEtNDhiYS04MTI3LTc0YTY0NzhjOWJjYi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1hNzNhMDc5ODY4OGJmMmJiNzM1ZDQzYmM5OWNjMjY5NGM3MmE2Mzg2MDg2ZTE1YjUxNjFjNDdiYzk2MmRmMDc3JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.Ag43bqLgMKCTe5YS7MxViwnmnSscAiiJ11D6Z_yB80U)](https://private-user-images.githubusercontent.com/100382372/384928616-e8183f56-a001-48ba-8127-74a6478c9bcb.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4NjE2LWU4MTgzZjU2LWEwMDEtNDhiYS04MTI3LTc0YTY0NzhjOWJjYi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1hNzNhMDc5ODY4OGJmMmJiNzM1ZDQzYmM5OWNjMjY5NGM3MmE2Mzg2MDg2ZTE1YjUxNjFjNDdiYzk2MmRmMDc3JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.Ag43bqLgMKCTe5YS7MxViwnmnSscAiiJ11D6Z_yB80U)[![image](https://private-user-images.githubusercontent.com/100382372/384928867-fbee6f2e-1dec-4487-9cc0-05e659170f3d.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4ODY3LWZiZWU2ZjJlLTFkZWMtNDQ4Ny05Y2MwLTA1ZTY1OTE3MGYzZC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT01NWJmODUxYTk1NTc3YjVkOGY5MzcwYjAyYWE2NjYwZGM3YjA2OThjY2IwOTM1ZTUwOTgzYmI0MjExNzc2NmY5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.AqoUtPt6Dr_WuDTVuEwWtfqt0UGTnZ4wxBxR82MUoA8)](https://private-user-images.githubusercontent.com/100382372/384928867-fbee6f2e-1dec-4487-9cc0-05e659170f3d.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTI4ODY3LWZiZWU2ZjJlLTFkZWMtNDQ4Ny05Y2MwLTA1ZTY1OTE3MGYzZC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT01NWJmODUxYTk1NTc3YjVkOGY5MzcwYjAyYWE2NjYwZGM3YjA2OThjY2IwOTM1ZTUwOTgzYmI0MjExNzc2NmY5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.AqoUtPt6Dr_WuDTVuEwWtfqt0UGTnZ4wxBxR82MUoA8)[![image](https://private-user-images.githubusercontent.com/100382372/384938540-ae1f621e-0b31-4c62-9fb3-3a85b1942346.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTM4NTQwLWFlMWY2MjFlLTBiMzEtNGM2Mi05ZmIzLTNhODViMTk0MjM0Ni5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kNTZhZGQyZWNiOWZhYWE2MzE2YjEwYmUzOTM3NjRjNjkzNThiZjEwYmFiMDQxNmQ5ZWRiY2FjMDUwNjA1YzE5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.V7raU0Hd8uH1V0yVEg0tnVCkevq8Rnom6FORNoEQ9X0)](https://private-user-images.githubusercontent.com/100382372/384938540-ae1f621e-0b31-4c62-9fb3-3a85b1942346.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzQ3MzQ0OTYsIm5iZiI6MTc3NDczNDE5NiwicGF0aCI6Ii8xMDAzODIzNzIvMzg0OTM4NTQwLWFlMWY2MjFlLTBiMzEtNGM2Mi05ZmIzLTNhODViMTk0MjM0Ni5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwMzI4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDMyOFQyMTQzMTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kNTZhZGQyZWNiOWZhYWE2MzE2YjEwYmUzOTM3NjRjNjkzNThiZjEwYmFiMDQxNmQ5ZWRiY2FjMDUwNjA1YzE5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.V7raU0Hd8uH1V0yVEg0tnVCkevq8Rnom6FORNoEQ9X0) 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) - [ZPMLabs](https://github.com/zpmlabs) - [All Contributors](../../contributors) License ------- [](#license) Proprietary license. Please see [License File](LICENSE.md) for more information. ### Health Score 48 — FairBetter than 95% of packages Maintenance86 Actively maintained with recent releases Popularity29 Limited adoption so far Community9 Small or concentrated contributor base Maturity55 Maturing project, gaining track record 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 Every ~120 days Total 5 Last Release 73d ago Major Versions v1.0.1 → 2.0.12025-07-07 2.0.1 → v4.x-dev2025-07-07 PHP version history (2 changes)v1.0.1PHP ^8.1 2.0.1PHP ^8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/211412089?v=4)[ZPM Labs](/maintainers/zpmlabs)[@ZPMLabs](https://github.com/ZPMLabs) --- Top Contributors [![sasaorasanin](https://avatars.githubusercontent.com/u/100382372?v=4)](https://github.com/sasaorasanin "sasaorasanin (5 commits)") --- Tags laravelfilament-api-docs-builderzpmlabs ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/zpmlabs-filament-api-docs-builder/health.svg) ``` [![Health](https://phpackages.com/badges/zpmlabs-filament-api-docs-builder/health.svg)](https://phpackages.com/packages/zpmlabs-filament-api-docs-builder) ``` ### Alternatives [rupadana/filament-api-service A simple api service for supporting filamentphp 204103.8k7](/packages/rupadana-filament-api-service)[scalar/laravel Render your OpenAPI-based API reference 6183.9k2](/packages/scalar-laravel)[ryangjchandler/bearer Minimalistic token-based authentication for Laravel API endpoints. 8129.8k](/packages/ryangjchandler-bearer)[tapp/filament-webhook-client Add a Filament resource and a policy for Spatie Webhook client 1120.2k](/packages/tapp-filament-webhook-client) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)