PHPackages                             luizalabs-opensource-php/laravel-request-docs - 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. [Utility & Helpers](/categories/utility)
4. /
5. luizalabs-opensource-php/laravel-request-docs

ActiveLibrary[Utility & Helpers](/categories/utility)

luizalabs-opensource-php/laravel-request-docs
=============================================

Automatically generate Laravel docs from request rules, controllers and routes, rakutentech fork

0.0.2(3y ago)0312MITBladePHP ^7.4|^8.0

Since Apr 18Pushed 3y agoCompare

[ Source](https://github.com/luizalabs-opensource-php/laravel-request-docs)[ Packagist](https://packagist.org/packages/luizalabs-opensource-php/laravel-request-docs)[ Docs](https://github.com/luizalabs-opensource-php/laravel-request-docs)[ RSS](/packages/luizalabs-opensource-php-laravel-request-docs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (12)Versions (3)Used By (0)

MODERNIZATION OF UI RENEWAL is in PROGRESS [rakutentech/laravel-request-docs#103](https://github.com/rakutentech/laravel-request-docs/pull/103)
===============================================================================================================================================

[](#modernization-of-ui-renewal-is-in-progress-httpsgithubcomrakutentechlaravel-request-docspull103)

We request to have code freeze on new pull requests, and request to please submit issues with regards to the UI that we can cover in the new UI renewal.

 [ ![Laravel Request Docs](https://camo.githubusercontent.com/fd6650e2027d7265b156713bccd4653964f90d3efa40d4c56f3babab02648373/68747470733a2f2f696d6775722e636f6d2f396544545561492e706e67) ](https://github.com/rakutentech/laravel-request-docs)

 The Hassle-Free automatic API documentation generation for Laravel.
 A Swagger alernative.
 Supports Open API 3.0.0

**Fast:** Install on any Laravel Project

**Hassle Free:** Auto Generate API Documentation for request rules and parameters

**Analyze:** In built SQL query time analyzer, response time and headers output.

**Supports:** Postman and OpenAPI 3.0.0 exports.

Features
--------

[](#features)

- Automatic routes fetching from Laravel Routes
- Automatic rules fetching from injected Request
- Support for Authorization Headers
- Support for SQL query, response time and memory consumption by request on Laravel
- Intelligent auto request builder using `faker.js`
- Display extra documentation using markdown
- Export laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0

Read on Medium
==============

[](#read-on-medium)

Automatically generate api documentation for Laravel without writing annotations.

Read more:

Requirements
------------

[](#requirements)

LangVersionsPHP7.4 or 8.0 or 8.1Laravel6.\* or 8.\* or 9.\*Installation
============

[](#installation)

You can install the package via composer:

```
composer require rakutentech/laravel-request-docs --dev
```

You can publish the config file with:

```
php artisan vendor:publish --tag=request-docs-config
```

Usage
=====

[](#usage)

Dashboard
---------

[](#dashboard)

View in the browser on `/request-docs/`

Generate a static HTML and open api specification

```
php artisan lrd:generate
```

Docs HTML is generated inside `docs/`.

Just want Open API
------------------

[](#just-want-open-api)

View in the browser on `/request-docs/?openapi=true`

Design pattern
==============

[](#design-pattern)

In order for this plugin to work, you need to follow the design pattern by injecting the request class inside the controller. For extra documentation you can use markdown inside your controller method as well.

[![Design pattern](https://camo.githubusercontent.com/c8df93a2782634c01caca681fdf553fcddd534d3875b84f3122326b42fb292c7/68747470733a2f2f696d6775722e636f6d2f79586a71336a702e706e67)](https://camo.githubusercontent.com/c8df93a2782634c01caca681fdf553fcddd534d3875b84f3122326b42fb292c7/68747470733a2f2f696d6775722e636f6d2f79586a71336a702e706e67)

Screenshots
===========

[](#screenshots)

**Generated API documentation**

[![Preview](https://camo.githubusercontent.com/191d4984dfe4bca9d7d0799c2d39c0c7936f5493b778dc336b12318adb7f1de1/68747470733a2f2f696d6775722e636f6d2f384476424268732e706e67)](https://camo.githubusercontent.com/191d4984dfe4bca9d7d0799c2d39c0c7936f5493b778dc336b12318adb7f1de1/68747470733a2f2f696d6775722e636f6d2f384476424268732e706e67)

**Try API**

[![Preview](https://camo.githubusercontent.com/09e8a31bca324b79997e4e6bee5c3febc303f78b9216a3003d9006be52840c92/68747470733a2f2f696d6775722e636f6d2f6b634b56537a6d2e706e67)](https://camo.githubusercontent.com/09e8a31bca324b79997e4e6bee5c3febc303f78b9216a3003d9006be52840c92/68747470733a2f2f696d6775722e636f6d2f6b634b56537a6d2e706e67)

**SQL query profile**

[![Preview](https://camo.githubusercontent.com/40d371037b408ee06f38c40d1a454500aceeca04f121b875e25672e35b179890/68747470733a2f2f696d6775722e636f6d2f79386a54336a6a2e706e67)](https://camo.githubusercontent.com/40d371037b408ee06f38c40d1a454500aceeca04f121b875e25672e35b179890/68747470733a2f2f696d6775722e636f6d2f79386a54336a6a2e706e67)

**Response profile**

[![Preview](https://camo.githubusercontent.com/ccf7ae509f81da79e2b05eaf202619acf4459745ae8c951cf83d8488107fba1c/68747470733a2f2f696d6775722e636f6d2f55304a653935362e706e67)](https://camo.githubusercontent.com/ccf7ae509f81da79e2b05eaf202619acf4459745ae8c951cf83d8488107fba1c/68747470733a2f2f696d6775722e636f6d2f55304a653935362e706e67)

**Customize Headers**

[![Preview](https://camo.githubusercontent.com/969af0f324c4ea83efcc0eb422ecb14e919b2a0c1f1e0fe0ef26c66ff2b98b32/68747470733a2f2f696d6775722e636f6d2f357964745264382e706e67)](https://camo.githubusercontent.com/969af0f324c4ea83efcc0eb422ecb14e919b2a0c1f1e0fe0ef26c66ff2b98b32/68747470733a2f2f696d6775722e636f6d2f357964745264382e706e67)

Extra
=====

[](#extra)

You write extra documentation in markdown which will be rendered as HTML on the dashboard. Example of using it in controller

```
    /**
     * @lrd:start
     * #Hello markdown
     * ## Documentation for /my route
     * @lrd:end
     */
    public function index(MyIndexRequest $request): Resource
    {
```

Custom Params
=============

[](#custom-params)

You write extra params with rules with @QAparam comment line

```
    /**
     * @QAparam search string
     */
    public function index(MyIndexRequest $request): Resource
    {
```

```
    /**
     * @QAparam search string nullable max:32
     */
    public function index(MyIndexRequest $request): Resource
    {
```

Testing
=======

[](#testing)

```
./vendor/bin/phpunit
```

Linting
=======

[](#linting)

```
./vendor/bin/phpcs --standard=phpcs.xml --extensions=php --ignore=tests/migrations config/ src/
```

Fixing lints

```
./vendor/bin/php-cs-fixer fix src/
./vendor/bin/php-cs-fixer fix config/
```

Changelog
=========

[](#changelog)

- Initial Release
- v1.9 Added improvements such as status code, response headers, custom request headers and fixed issues reported by users
- v1.10 Show PHP memory usage, gzip encoding fix
- v1.12 Bug Fix of id, and Laravel 9 support
- v1.13 Laravel 9 support
- v1.15 Adds Filter and fall back to regexp upon Exception
- v1.17 Donot restrict to FormRequest
- v1.18 Fix where prism had fixed height. Allow text area resize.
- v1.18 Updated UI and pushed unit tests
- v1.19 Exception -> Throwable for type error
- v1.20 Feature support open api 3.0.0 #10
- v1.21 Abililty to add custom params
- v1.22 Boolean|File|Image support
- v1.22 Boolean|File|Image support
- v1.23 Bug fix for lrd doc block #76
- v1.27 A few fixes on width and added request\_methods
- v1.30 Minor search box filter added

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity41

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 ~0 days

Total

2

Last Release

1126d ago

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

laravellaravel-request-docsrakutentech-fork

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/luizalabs-opensource-php-laravel-request-docs/health.svg)

```
[![Health](https://phpackages.com/badges/luizalabs-opensource-php-laravel-request-docs/health.svg)](https://phpackages.com/packages/luizalabs-opensource-php-laravel-request-docs)
```

###  Alternatives

[rakutentech/laravel-request-docs

Automatically generate Laravel docs from request rules, controllers and routes

7861.2M2](/packages/rakutentech-laravel-request-docs)[spatie/laravel-data

Create unified resources and data transfer objects

1.8k28.9M627](/packages/spatie-laravel-data)[hirethunk/verbs

An event sourcing package that feels nice.

513162.9k6](/packages/hirethunk-verbs)[worksome/exchange

Check Exchange Rates for any currency in Laravel.

123544.7k](/packages/worksome-exchange)[ralphjsmit/livewire-urls

Get the previous and current url in Livewire.

82270.3k4](/packages/ralphjsmit-livewire-urls)[hydrat/filament-table-layout-toggle

Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts.

6292.3k1](/packages/hydrat-filament-table-layout-toggle)

PHPackages © 2026

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