Download the PHP package edrisaturay/filament-api-docs-builder without Composer
On this page you can find all versions of the php package edrisaturay/filament-api-docs-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download edrisaturay/filament-api-docs-builder
More information about edrisaturay/filament-api-docs-builder
Files in edrisaturay/filament-api-docs-builder
Package filament-api-docs-builder
Short Description This package will give you the best API docs building experience.
License MIT
Homepage https://github.com/edrisaturay/filament-api-docs
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package filament-api-docs-builder
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
- 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
Since this package is currently in development and depends on newer Laravel components, you should install it with the dev-main constraint:
You can install the package with:
Also you need to add a source to your custom theme:
Otherwise you can publish and run the migrations with:
You can publish the config file with:
Optionally, you can publish the views using
Usage
You can use this package by registering the plugin inside you filament service provider.
Otherwise you can make your own resource and ApiDocsFormBuilder for form generation.
And ApiDocsInfolistBuilder for infolist generation.
There are also two actions for export and import docs with postman json standard.
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
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Original Author: ZPMLabs - Original
zpmlabs/filament-api-docs-builderpackage - Maintainer: Edrisa Turay
- All Contributors
License
MIT License. Please see License File 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.
All versions of filament-api-docs-builder with dependencies
filament/filament Version ^4.0|^5.0
zpmlabs/filament-icon-picker Version ^1.0.0
spatie/laravel-package-tools Version ^1.15|^2.0
tempest/highlight Version ^2.10