targettech/laravel-api-doc-generator

Auto generate Laravel api documentation from form request rules, controllers and routes

dev-main 2022-09-15 13:15 UTC

Requires

• php: ^7.3|^7.4|^8.0|^8.1
• illuminate/contracts: ^9.26.1
• phpdocumentor/reflection-docblock: ^5.3
• spatie/laravel-package-tools: ^1.4.3

Requires (Dev)

• brianium/paratest: ^6.6.3
• nunomaduro/collision: ^v6.0.0
• orchestra/testbench: ^7.7.0
• phpunit/phpunit: ^9.3
• spatie/laravel-ray: ^1.30.0
• vimeo/psalm: ^4.8

MIT

• Rawa Hamid

• laravel
• targettech
• laravel-api-doc-generator

README

Automatically generate api documentation for Laravel without writing annotations.

Requirements

Installation

You can install the package via composer:

composer require targettech/laravel-api-doc-generator --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

Testing

./vendor/bin/phpunit

Changelog

• Initial Release