Download the PHP package rich2k/l5-swagger without Composer

On this page you can find all versions of the php package rich2k/l5-swagger. 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 l5-swagger

Total Downloads Build Status Coverage Status Code Climate StyleCI

L5 Swagger - OpenApi or Swagger Specification for your Laravel project made easy.

Swagger 2.0 for Laravel >=5.1

This package is a wrapper of Swagger-php and swagger-ui adapted to work with Laravel 5.

Installation

Laravel Swagger UI OpenAPI Spec compatibility L5-Swagger
7.0.x 3 3.0, 2.0 composer require "darkaonline/l5-swagger"

:warning: !!! run composer require 'zircote/swagger-php:2.*' if you need old @SWG (SWAGGER annotations) support. !!!
6.0.x 3 3.0, 2.0 composer require "darkaonline/l5-swagger:6.*"

:warning: !!! run composer require 'zircote/swagger-php:2.*' if you need old @SWG (SWAGGER annotations) support. !!!
5.8.x 3 3.0, 2.0 composer require "darkaonline/l5-swagger:5.8.*"

:warning: !!! run composer require 'zircote/swagger-php:2.*' if you need old @SWG (SWAGGER annotations) support. !!!
5.7.x OR 5.6.x 3 3.0, 2.0 composer require "darkaonline/l5-swagger:5.7.*"

:warning: !!! run composer require 'zircote/swagger-php:2.*' if you need old @SWG (SWAGGER annotations) support. !!!
5.6.x 3 2.0 composer require "darkaonline/l5-swagger:5.6.*"
5.5.x 3 2.0 composer require "darkaonline/l5-swagger:5.5.*"
5.4.x 3 2.0 composer require "darkaonline/l5-swagger:5.4.*"
5.4.x 2.2 1.1, 1.2, 2.0 composer require "darkaonline/l5-swagger:~4.0"
5.3.x 2.2 1.1, 1.2, 2.0 composer require "darkaonline/l5-swagger:~3.0"
5.2.x 2.2 1.1, 1.2, 2.0 composer require "darkaonline/l5-swagger:~3.0"
5.1.x 2.2 1.1, 1.2, 2.0 composer require "darkaonline/l5-swagger:~3.0"

You can publish L5-Swagger's config and view files into your project by running:

For Laravel >=5.5, no need to manually add L5SwaggerServiceProvider into config. It uses package auto discovery feature. Skip this if you are on >=5.5, if not:

Open your AppServiceProvider (located in app/Providers) and add this line in register function

or open your config/app.php and add this line in providers section

You can access your documentation at /api/documentation endpoint.

Swagger/OpenApi annotations and generating documentation

In order to generate the Swagger/OpenApi documentation for your API, Swagger offers a set of annotations to declare and manipulate the output. These annotations can be added in your controller, model or even a seperate file. An example of OpenApi annotations can be found here and Swagger annotations can be found here. For more info check out Swagger's "pet store" example or the Swagger OpenApi Specification.

After the annotiations have been added you can run php artisan l5-swagger:generate to generate the documentation. Alternatively, you can set L5_SWAGGER_GENERATE_ALWAYS to true in your .env file so that your documentation will automatically be generated. Make sure your settings in config/l5-swagger.php are complete.

I am still using Swagger @SWG annotation

If still using Swagger @SWG annotations in you project you should:

or in your config/l5-swagger.php:

Using Swagger UI with Passport

The easiest way to build and test your Laravel-based API using Swagger-php is to use Passport's CreateFreshApiToken middleware. This middleware, built into Laravel's core, adds a cookie to all responses, and the cookie authenticates all subsequent requests through Passport's TokenGuard.

To get started, first publish L5-Swagger's config and view files into your own project:

Next, edit your config/l5-swagger.php configuration file. Locate the l5-swagger.routes.middleware section, and add the following middleware list to the api route:

TIPS

L5_SWAGGER_GENERATE_ALWAYS

One of the setting I find useful to enable is l5-swagger.generate_always, which will cause your Swagger doc to be regenerated each time you load the Swagger UI (not intended for production use!). All you have to do to enable this in your dev environment is add an environment variable to .env named L5_SWAGGER_GENERATE_ALWAYS and set it to true.

oauth2 + passport = Bearer \<token>

Follow instruction in issue #57.

Changes in 5.0

Changes in 4.0

Changes in 3.2.1

Changes in 3.2

Changes in 3.1

Changes in 3.0

Migrate from 2.0 to 3.0

Migrate from 3.0|4.0 to 5.0

Configuration

For versions < 5.5

Swagger-php

The actual Swagger spec is beyond the scope of this package. All L5-Swagger does is package up swagger-php and swagger-ui in a Laravel-friendly fashion, and tries to make it easy to serve. For info on how to use swagger-php look here. For good examples of swagger-php in action look here.

Support on Beerpay

Hey dude! Help me out for a couple of :beers:!

Beerpay Beerpay


All versions of l5-swagger with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2
laravel/framework Version ^6.0|^7.0|^8.0
zircote/swagger-php Version ~2.0|3.*
swagger-api/swagger-ui Version ^3.0
symfony/yaml Version ^5.0
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 rich2k/l5-swagger contains the following files

Loading the files please wait ....