Download the PHP package dilneiss/laravel-request-docs without Composer
On this page you can find all versions of the php package dilneiss/laravel-request-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dilneiss/laravel-request-docs
More information about dilneiss/laravel-request-docs
Files in dilneiss/laravel-request-docs
Package laravel-request-docs
Short Description Automatically generate Laravel docs from request rules, controllers and routes
License MIT
Homepage https://github.com/rakutentech/laravel-request-docs
Informations about the package 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.
Requirements
Lang | Version |
---|---|
PHP | 7.4 or 8.0 |
Laravel | 6. or 8. or 9.* |
Installation
You can install the package via composer:
You can publish the config file with:
Usage
View in the browser on /request-docs/
or generate a static HTML
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
SQL query profile
Resonse profile
Customize Headers
Extra
You write extra documentation in markdown which will be rendered as HTML on the dashboard. Example of using it in controller
Testing
Linting
Fixing lints
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
All versions of laravel-request-docs with dependencies
illuminate/contracts Version ^8.37|^9.0|^10.0|^11.0|^12.0
kitloong/laravel-app-logger Version ^1.0
spatie/laravel-package-tools Version ^1.4.3