Download the PHP package luizalabs-opensource-php/laravel-request-docs without Composer
On this page you can find all versions of the php package luizalabs-opensource-php/laravel-request-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download luizalabs-opensource-php/laravel-request-docs
More information about luizalabs-opensource-php/laravel-request-docs
Files in luizalabs-opensource-php/laravel-request-docs
Package laravel-request-docs
Short Description Automatically generate Laravel docs from request rules, controllers and routes, rakutentech fork
License MIT
Homepage https://github.com/luizalabs-opensource-php/laravel-request-docs
Informations about the package laravel-request-docs
MODERNIZATION OF UI RENEWAL is in PROGRESS https://github.com/rakutentech/laravel-request-docs/pull/103
We request to have code freeze on new pull requests, and request to please submit issues with regards to the UI that we can cover in the new UI renewal.
The Hassle-Free automatic API documentation generation for Laravel.
A Swagger alernative.
Supports Open API 3.0.0
Fast: Install on any Laravel Project
Hassle Free: Auto Generate API Documentation for request rules and parameters
Analyze: In built SQL query time analyzer, response time and headers output.
Supports: Postman and OpenAPI 3.0.0 exports.
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
- Export laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0
Read on Medium
Automatically generate api documentation for Laravel without writing annotations.
Requirements
Lang | Versions |
---|---|
PHP | 7.4 or 8.0 or 8.1 |
Laravel | 6. or 8. or 9.* |
Installation
You can install the package via composer:
You can publish the config file with:
Usage
Dashboard
View in the browser on /request-docs/
Generate a static HTML and open api specification
Docs HTML is generated inside docs/
.
Just want Open API
View in the browser on /request-docs/?openapi=true
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
Response 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
Custom Params
You write extra params with rules with @QAparam comment line
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
- v1.17 Donot restrict to FormRequest
- v1.18 Fix where prism had fixed height. Allow text area resize.
- v1.18 Updated UI and pushed unit tests
- v1.19 Exception -> Throwable for type error
- v1.20 Feature support open api 3.0.0 #10
- v1.21 Abililty to add custom params
- v1.22 Boolean|File|Image support
- v1.22 Boolean|File|Image support
- v1.23 Bug fix for lrd doc block #76
- v1.27 A few fixes on width and added request_methods
- v1.30 Minor search box filter added
All versions of laravel-request-docs with dependencies
illuminate/contracts Version ^8.37|^9.0
kitloong/laravel-app-logger Version ^1.0
spatie/laravel-package-tools Version ^1.4.3
ext-json Version *