PHPackages                             g4t/documentation - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. g4t/documentation

ActiveLibrary[API Development](/categories/api)

g4t/documentation
=================

Auto Generate Laravel api Documentation

1.2.1(4y ago)626[1 PRs](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator/pulls)MITPHP

Since Sep 30Pushed 4y ago1 watchersCompare

[ Source](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator)[ Packagist](https://packagist.org/packages/g4t/documentation)[ Docs](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator)[ RSS](/packages/g4t-documentation/feed)WikiDiscussions 1.2 Synced 1w ago

READMEChangelog (4)Dependencies (3)Versions (6)Used By (0)

Laravel Dark Documentation Generator 💥
======================================

[](#laravel-dark-documentation-generator-)

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

[](#you-can-create-documentation-for-your-api-easily-by-using-this-library)

[![me](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator/raw/1.2/image.PNG)](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator/blob/1.2/image.PNG)

Installation:
-------------

[](#installation)

Require this package with composer using the following command:

```
composer require g4t/documentation
```

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

Default Endpoints
-----------------

[](#default-endpoints)

##### For documentation `http://yoururl/g4t/doc`

[](#for-documentation-httpyoururlg4tdoc)

##### For json `http://yoururl/g4t/json`

[](#for-json-httpyoururlg4tjson)

You can change this endpoints from `config/documentation.php`

```
 'g4t/json',
    'documentation_url' => 'g4t/doc'
];
```

Usage
-----

[](#usage)

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

[](#when-you-create-route-in-apiphp-this-package-will-work-)

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

[](#if-you-send-data-in-body-or-query-params-you-should-add-some-comments-before-function-)

#### You have two ways to use it

[](#you-have-two-ways-to-use-it)

#### 💥 1 - by using auto database schema detect

[](#-1---by-using-auto-database-schema-detect)

### Example:

[](#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-explain)

CommentDescriptionStatus`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 namenot Required`table:`to get table `users` schema`remove:`to remove columns from DocuumentationNot Required`replace:`to replace input types in DocumentationNot Required`end FunctionName function`you should write function Name in `FunctionName`Required### 💥 2 - manualy

[](#-2---manualy)

### Example:

[](#example-1)

```
    /**
     * 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-explain-1)

CommentDescriptionStatus`auth`if this function need auth , if you using auth middleware on route you don't need to add this commentnot 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

[](#license)

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

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

6

Last Release

1678d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d7b7c2556272b7d41b2b756e7791f812c3a22b8ab34fa69d47ae1d8806b67cb6?d=identicon)[hussein4alaa](/maintainers/hussein4alaa)

---

Top Contributors

[![hussein4alaa](https://avatars.githubusercontent.com/u/13614747?v=4)](https://github.com/hussein4alaa "hussein4alaa (24 commits)")

---

Tags

apidocumentationlaravellaraveldocumentationapi-documentation

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/g4t-documentation/health.svg)

```
[![Health](https://phpackages.com/badges/g4t-documentation/health.svg)](https://phpackages.com/packages/g4t-documentation)
```

###  Alternatives

[mpociot/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

3.5k3.1M12](/packages/mpociot-laravel-apidoc-generator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)