Download the PHP package g4t/documentation without Composer
On this page you can find all versions of the php package g4t/documentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download g4t/documentation
More information about g4t/documentation
Files in g4t/documentation
Download g4t/documentation
More information about g4t/documentation
Files in g4t/documentation
Vendor g4t
Package documentation
Short Description Auto Generate Laravel api Documentation
License MIT
Homepage https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator
Package documentation
Short Description Auto Generate Laravel api Documentation
License MIT
Homepage https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator
Please rate this library. Is it a good library?
Informations about the package documentation
Laravel Dark Documentation Generator 💥
You can create Documentation for your api easily by using this library
Installation:
Require this package with composer using the following command:
Default Endpoints
For documentation http://yoururl/g4t/doc
For json http://yoururl/g4t/json
You can change this endpoints from config/documentation.php
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:
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:
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.
All versions of documentation with dependencies
PHP Build Version
Package Version
Requires
illuminate/support Version
~7|~8
The package g4t/documentation contains the following files
Loading the files please wait ....