exclusivedev/laravel-request-docs

Automatically generate Laravel docs from request rules, controllers and routes

1.17 2022-03-03 13:41 UTC

This package is not auto-updated.

Last update: 2024-10-18 10:16:34 UTC


README

Laravel Request Docs

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

Fast: Install on any Laravel Project

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

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

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

Read on Medium

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

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.

Design pattern

Screenshots

Generated API documentation

Preview

Try API

Preview

SQL query profile

Preview

Resonse profile

Preview

Customize Headers

Preview

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
    {

Testing

./vendor/bin/phpunit

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

  • 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