Automatically Generate API Documentation of Laravel Apps

Automatically Generate API Documentation of Laravel Apps cover image

Laravel Docs Generator is an effortless API documentation tool for Laravel applications & you can use it as a Swagger. With this package, You can automatically generate API documentation for Laravel without writing annotations.

Requirements

  • 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 --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 docs/.

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


For more details and source code, you can visit Github.

Written by

Rizwan Aslam

Founder and CEO of CodeBrisk, with years of experience building web applications with Laravel and leading a team of expert developers.

More about Rizwan
Book a free call
Book a free call with CodeBrisk Open in new tab