Skip to content

hobby10/laravel-request-docs

Repository files navigation

Laravel Docs Generator

Automatically generate docs from request Rules

Requirements

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

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 --provider="Rakutentech\LaravelRequestDocs\LaravelRequestDocsServiceProvider"

Usage

php artisan laravel-request-docs

Docs HTML is generated inside docs/.

Sample

Screenshot

Get JSON output

Testing

./vendor/bin/phpunit

Changelog

  • Initial Release - POC

TODO

  • Support Swagger

About

Effortless API documentation tool for Laravel applications. Swagger alternative.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Blade 67.6%
  • PHP 32.4%