Download the PHP package zpmlabs/filament-api-docs-builder without Composer

On this page you can find all versions of the php package zpmlabs/filament-api-docs-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of zpmlabs/filament-api-docs-builder

Informations about the package filament-api-docs-builder

image

Filament Api Docs Builder

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package allows you to build a good looking and functional api documentation. Including exporting and importing actions with postman standard.

Installation

You can install the package via composer repositories:

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

image image image

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

License

Proprietary license. Please see License File for more information.

All versions of filament-api-docs-builder with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
filament/filament Version ^4.0
zpmlabs/filament-icon-picker Version ^1.0.0
spatie/laravel-package-tools Version ^1.15.0
tempest/highlight Version ^2.10
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package zpmlabs/filament-api-docs-builder contains the following files

Loading the files please wait ....