Download the PHP package piovezanfernando/laravel-api-auto-docs without Composer

On this page you can find all versions of the php package piovezanfernando/laravel-api-auto-docs. 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 piovezanfernando/laravel-api-auto-docs

Informations about the package laravel-api-auto-docs

Laravel API Auto Docs

License MIT PHP 8.4+

The Hassle-Free automatic API documentation generation for Laravel.
A Swagger alternative with modern Vue 3 interface.
Supports Open API 3.0.0

Features

Requirements

Installation

You can install the package via composer:

Publish the config file:

Configuration

The configuration file will be published to config/api-auto-docs.php. Here you can configure:

Usage

Accessing the Documentation

By default, the documentation is available at:

Generating OpenAPI Specification

To generate the OpenAPI specification file:

This will create an api.json file in your project's root directory by default. You can specify a different path:

Adding Descriptions to Controllers

The package automatically reads the summary and description from your controller methods' PHPDoc comments.

Request Validation

The package automatically reads Laravel FormRequest validation rules:

Configuration Options

Exclude Routes

In config/api-auto-docs.php:

Middleware

UI Customization

Testing Your API

The built-in UI allows you to:

Export Options

OpenAPI 3.0

Access the OpenAPI specification:

Download the JSON representation via:

Security

If you want to restrict access to the documentation:

Credits

This package is based on the excellent work from
Laravel Request Docs by Rakuten Tech.

All credit for the original idea and implementation goes to
Pulkit Kathuria and the Rakuten Tech engineering team.

This fork extends the original project with additional features, UI redesign, and ongoing maintenance, while preserving the MIT license.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

The MIT License (MIT). Please see License File for more information.

Support

Colaboradores

All versions of laravel-api-auto-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3|^8.4
illuminate/contracts Version ^11.0|^12.0|^13.0
kitloong/laravel-app-logger Version ^1.0
spatie/laravel-package-tools Version ^1.4.3
ext-json Version *
phpdocumentor/reflection-docblock Version ^5.4.1
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 piovezanfernando/laravel-api-auto-docs contains the following files

Loading the files please wait ...