nrdq/laravel-request-docs

Automatically generate Laravel docs from request rules, controllers and routes

This package's canonical repository appears to be gone and the package has been frozen as a result.

dev-master 2021-12-06 09:55 UTC

Requires

• php: ^7.4|^8.0
• illuminate/contracts: ^8.37
• spatie/laravel-package-tools: ^1.4.3

Requires (Dev)

• brianium/paratest: ^6.2
• nunomaduro/collision: ^5.3
• orchestra/testbench: ^6.15
• phpunit/phpunit: ^9.3
• spatie/laravel-ray: ^1.23
• vimeo/psalm: ^4.8

MIT

• Nordique BV

• laravel
• laravel-request-docs
• nrdq

README

Automatically generate api documentation for Laravel without writing annotations.

Read more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e

Requirements

Lang	Version
PHP	7.4 or 8.0
Laravel	6. or 8.

Installation

You can install the package via composer:

composer require nrdq/laravel-request-docs --dev

You can publish the config file with:

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

Usage

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

or generate a static HTML

php artisan lrd:generate

Docs HTML is generated inside the `docs/` folder.

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.

Screenshots

Generated API documentation

Try API

Testing

./vendor/bin/phpunit

Changelog

• Initial Release