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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
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

me

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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package g4t/documentation contains the following files

Loading the files please wait ....