Download the PHP package apoplavs/laravel-autodoc without Composer

On this page you can find all versions of the php package apoplavs/laravel-autodoc. 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?

Informations about the package laravel-autodoc

Laravel AutoDoc plugin

This library is designed to gather information passing the features tests and generate documentation about your API. The principle of operation is based on the fact that the special Middleware installed on the Route for which you want to collect information that after the successful completion of all tests generated Swagger-file. In addition this plug-in is able to draw Swagger-template to display the generated documentation for a config.

Installation

Composer

  1. composer require apoplavs/laravel-swagger

Laravel

  1. add Apoplavs\Support\AutoDoc\AutoDocServiceProvider::class, to providers in config/app.php
  2. run php artisan vendor:publish

Plugin

  1. Add middleware \Apoplavs\Support\AutoDoc\Http\Middleware\AutoDocMiddleware::class to Http/Kernel.php.
  2. Use \Apoplavs\Support\AutoDoc\Tests\AutoDocTestCaseTrait in your TestCase in tests/TestCase.php
  3. In config/auto-doc.php you can specify enabling of plugin, info of your project, some defaults descriptions and route for rendering of documentation.
  4. In .env file you should add following lines

AUTODOC_ENABLED - enable or disable generate of documentation when passing a tests

LOCAL_DATACOLLECTOR..._PATH - custom path to your generated documentation file

You can disable autodoc for one test, just need before running test, set AutoDocMiddleware::$skipped = true;

Usages

For correct working of plugin you have to dispose all the validation rules in the rules() method of class YourRequest, which must be connected to the controller via DependencyInjection. In annotation of custom request you can specify summary and description of this request. Plugin will take validation rules from your request and use it as description of input parameter. If you want to set to common description of your API endpoints you can rewrite swagger-description.blade.php in your views and customize as you want. It will be render as blade template.

Example

Note about configs:

Also you can specify way to collect documentation by creating your custom data collector class.

This plugin based on https://github.com/RonasIT/laravel-swagger


All versions of laravel-autodoc with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1.0
laravel/framework Version >=5.3.0
minime/annotations Version 2.3.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 apoplavs/laravel-autodoc contains the following files

Loading the files please wait ....