Download the PHP package zquintana/lara-swag without Composer

On this page you can find all versions of the php package zquintana/lara-swag. 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 zquintana/lara-swag

Informations about the package lara-swag

Lara Swag

Build Status Total Downloads Latest Stable Version

The LaraSwag package allows you to generate a decent documentation for your APIs.

Installation

First, open a command console, enter your project directory and execute the following command to download the latest version of this bundle (still in beta, for a stable version look here):

Then add the service provider to your app config:

To install the vendor assets like configurations and templates run:

To browse your documentation with Swagger UI, register the routes in config/routing/lara_swag.php. To make this easier after you run the vendor:publish command you can add the following to your routes config file:

What does this bundle?

It generates you a swagger documentation from your Laravel app thanks to Describers. Each of these Describers extract infos from various sources. For instance, one extract data from SwaggerPHP annotations, one from your routes, etc.

If you configured the routes above, you can browse your documentation at http://example.org/api/docs.

Use the bundle

You can configure globally your documentation in the config (take a look at the Swagger specification to know the fields available):

To document your routes, you can use annotations in your controllers:

What's supported?

This package supports Laravel route requirements, PHP annotations, Swagger-Php annotations.

It supports models through the @Model annotation.

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/zquintana/LaraSwag.git
cd LaraSwag
composer install

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.

All versions of lara-swag with dependencies

PHP Build Version
Package Version
Requires php Version ~7.0|~7.1
symfony/property-info Version ^3.1|^4.0
exsyst/swagger Version ~0.2.3
zircote/swagger-php Version ^2.0.9
indigophp/doctrine-annotation-autoload Version ^0.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 zquintana/lara-swag contains the following files

Loading the files please wait ....