Download the PHP package mindedge/laravel-api-doc without Composer

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

Informations about the package laravel-api-doc

Laravel-Api-Doc

Automatically create documentation for Laravel api's off the registered routes and PHPDoc comments

Table of Contents

Installation

You can install the package via composer:

How it works

Take the below example route url and controller method:

POST Request: /1.0/pages/1234/posts

This library will scan the registered Laravel routes, and see that /1.0/pages/1234/posts is registered to PostController@create.

It will then scan the create method definition for route parameters. This is so we always grab the true parameter list even if the PHPDoc comments don't include them.

If the first parameter is an instance of Illuminate\Foundation\Http\FormRequest we will scan the class for a rules() method to build a list of the form/query parameters.

The we will continue parsing the controller create method to get the route parameters. In this example we have $page_id so we will check the PHPDoc comments to grab a description of what this parameter does.

Usage

Basic Usage:

Get the routes as an OpenApi json object:

Get the routes as an OpenApi php array:

Advanced Usage

You can supply a partially pre-filled document to Doc::generate() to set default values

License

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

All versions of laravel-api-doc with dependencies

PHP Build Version
Package Version
Requires laravel/framework Version ^10
goldspecdigital/laravel-eloquent-uuid Version ^10.0
symfony/yaml Version ^6
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 mindedge/laravel-api-doc contains the following files

Loading the files please wait ....