g4t/documentation

Auto Generate Laravel api Documentation

1.2.1 2021-10-03 07:09 UTC

Requires

• illuminate/support: ~7|~8

Requires (Dev)

• orchestra/testbench: ~5|~6
• phpunit/phpunit: ~9.0

MIT

• HusseinAlaa

• documentation
• laravel
• api documentation

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

Comment	Description	Status
start FunctionName function	you should write function Name in FunctionName	Required
title:	This title will show in documentation , if this not found will use function name	not Required
table:	to get table users schema
remove:	to remove columns from Docuumentation	Not Required
replace:	to replace input types in Documentation	Not Required
end FunctionName function	you should write function Name in FunctionName	Required

💥 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

Comment	Description	Status
auth	if this function need auth , if you using auth middleware on route you don't need to add this comment	not Required
string $name required	name column is string and required
int $number	number column is integer and not required
email $email required	email column is string and input type in documentation is email and required
password $password	password column is string and input type in documentation is password and not required
file $image	image column is string and input type in documentation is image and not required

License

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