All Projects → appointer → swaggervel

appointer / swaggervel

Licence: other
Swagger for Laravel

Projects that are alternatives of or similar to swaggervel

voyager-portfolio
A Portfolio Module for Laravel Voyager 💋
Stars: ✭ 15 (-78.57%)
Mutual labels:  laravel-package
laravel-charts-css
Laravel component to create gorgeous Charts.css charts.
Stars: ✭ 105 (+50%)
Mutual labels:  laravel-package
laravel-test-watcher
Laravel Test Watcher
Stars: ✭ 20 (-71.43%)
Mutual labels:  laravel-package
laravel-smart-facades
Strategy design pattern in laravel, the easiest way.
Stars: ✭ 84 (+20%)
Mutual labels:  laravel-package
laravel-ab
Laravel A/B experiment testing tool
Stars: ✭ 108 (+54.29%)
Mutual labels:  laravel-package
pushbullet
Pushbullet notifications channel for Laravel
Stars: ✭ 14 (-80%)
Mutual labels:  laravel-package
laracash
PHP Laravel Money Package 💰
Stars: ✭ 52 (-25.71%)
Mutual labels:  laravel-package
laravel-sybase
Connection and Laravel Eloquent driver for Sybase
Stars: ✭ 29 (-58.57%)
Mutual labels:  laravel-package
lastfm
🎶 Last.fm API client for PHP. Comes with a Laravel service provider.
Stars: ✭ 17 (-75.71%)
Mutual labels:  laravel-package
laravel-embed
Effortless responsive embeds for videos, slideshows and more.
Stars: ✭ 106 (+51.43%)
Mutual labels:  laravel-package
voyager-page-blocks
A module to provide page blocks for Voyager 📝
Stars: ✭ 80 (+14.29%)
Mutual labels:  laravel-package
laravel-snowflake
This Laravel package to generate 64 bit identifier like the snowflake within Twitter.
Stars: ✭ 94 (+34.29%)
Mutual labels:  laravel-package
bread-templates
BREAD Templates with Voyager
Stars: ✭ 19 (-72.86%)
Mutual labels:  laravel-package
laravel-helper-functions
Laravel-specific and pure PHP Helper Functions.
Stars: ✭ 106 (+51.43%)
Mutual labels:  laravel-package
airbrake-laravel
Laravel package for the Airbrake API, which supports Errbit
Stars: ✭ 16 (-77.14%)
Mutual labels:  laravel-package
simple-recaptcha-v3
🤖 This repository contains simple reCAPTCHA v3 integration for your Laravel application.
Stars: ✭ 25 (-64.29%)
Mutual labels:  laravel-package
laravel-dadata
PHP SDK Laravel пакет работы с сервисом DaData.ru, для исправления синтаксических ошибок в информации контактных данных клиентов сайта и вывода подсказок поля форм.
Stars: ✭ 39 (-44.29%)
Mutual labels:  laravel-package
gitup
Laravel package to upload git commits to server(s) via (s)ftp.
Stars: ✭ 20 (-71.43%)
Mutual labels:  laravel-package
apposite
Conditionally apply Laravel validation rules, even when you don't have access to the validator instance.
Stars: ✭ 36 (-48.57%)
Mutual labels:  laravel-package
spid-laravel
SPID authentication package for Laravel
Stars: ✭ 41 (-41.43%)
Mutual labels:  laravel-package

Swaggervel (Swagger integration for Laravel 5)

This package combines Swagger-php and swagger-ui into one Laravel-friendly package. When you run your app in debug mode, Swaggervel will scan your app folder (or any folder that is set under the "app-dir" variable in the packages config), generate swagger json files and deposit them to the doc-dir folder (default is /docs). Files are then served by swagger-ui under the api-docs director.

Installation

  • Execute composer require appointer/swaggervel --dev within your laravel root directory
  • Add Appointer\Swaggervel\SwaggervelServiceProvider::class to your providers array in app/config/app.php above your route provider, to avoid any catch-all routes
  • Run php artisan vendor:publish --tag=public to push swagger-ui to your public folder (can be found in public/vendor/swaggervel).
  • Optionally run php artisan vendor:publish --tag=config to push the swaggervel default config into your application's config directory.
  • Optionally run php artisan vendor:publish --tag=views to push the swaggervel index view file into resources/views/vendor/swaggervel.

Examples (when using the default configuration)

Options

All options are well commented within the swaggervel.php config file.

How to Use Swagger-php

The actual Swagger spec is beyond the scope of this package. All Swaggervel 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.

Further Notes

This package is a fork of slampenny/Swaggervel, as it is no longer maintained.

TODO

  • the handling of the /doc call is still really inconsistent, as you cannot change the file name (api-docs.json), but are able to change the file you acces when using the /doc route.
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].