Giter Club home page Giter Club logo

docrouter's Introduction

Documentation Router for Laravel

Allow routing on controller class and method documentation

To install on laravel root directory terminal type composer require grimbees/docrouter

Supported annotation on controller class:
@middleware values, values would be any middleware that is registered
@prefix values, values would be any url escaped string

Supported annotation on controller method:
@method values, values would be any, post, get
@route values, values would be any url escaped string

To get started:
Add GrimBees\DocRouter\DocRouterServiceProvider::class to config/app.php on $providers

Example: MyController.php

namespace App\Http\Controllers;

/**
 * Class MyController
 * @middleware web
 * @prefix my
 */
class MyController extends Controller
{

    /**
     * @method any
     * @route test
     */
    public function test() {
        return "test";
    }

}

Type composer dump-autoload is required for new controller

Test controller method will be exposed on /my/test

docrouter's People

Contributors

grimbees avatar

Stargazers

 avatar

Watchers

 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.