README

You can create Documentation for your api easily by using this library

Installation:

Require this package with composer using the following command:

composer require g4t/documentation

php artisan vendor:publish --provider=g4t\Documentation\DocumentationServiceProvider

Default Endpoints

For documentation http://yoururl/g4t/doc

For json http://yoururl/g4t/json

You can change this endpoints from config/documentation.php

<?php
return [
    'json_url' => 'g4t/json',
    'documentation_url' => 'g4t/doc'
];

Usage

when you create route in api.php this package will work 😉

if you send data in body or query params You should add some comments before function 😔

You have two ways to use it

💥 1 - by using auto database schema detect

Example:

    /**
     * start FunctionName function
     * title: Create Users
     * table: users
     * remove: ["remember_token", "email_verified_at"]
     * replace: {"password": "password", "email": "email", "image": "file"}
     * end FunctionName function
     */

Comment Explain

💥 2 - manualy

Example:

    /**
     * start FunctionName function
     * auth
     * title: get user by id
     * string $name required
     * int $number
     * email $email required
     * password $password
     * file $image
     * end FunctionName function
     */

Comment Explain

License

Laravel Dark Documentation Generator is free software licensed under the MIT license.