Giter VIP home page Giter VIP logo

swagger's Introduction

Swagger

For Laravel 4, please use the 0.3 branch!

Swagger for Laravel 5

This package combines swagger-php and swagger-ui into one Laravel-friendly package.

When you run your app in debug mode, Swagger will scan your Laravel app folder, generate swagger json files and deposit them to the docs-dir folder (default is "docs"). Files are then served by swagger-ui under the api-docs director.

Installation

composer require latrell/swagger dev-master

Update your packages with composer update or install with composer install.

Usage

To use the Swagger Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this.

Find the providers key in config/app.php and register the Swagger Service Provider.

    'providers' => [
        // ...
        'Latrell\Swagger\SwaggerServiceProvider',
    ]

Run php artisan vendor:publish to push swagger-ui to your public folder and publish the config file.

Config file config/latrell-swagger.php is the primary way you interact with Swagger.

Example

swagger's People

Contributors

latrell avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.