{"id":27215445,"url":"https://github.com/rakutentech/laravel-request-docs","last_synced_at":"2026-04-02T12:01:31.601Z","repository":{"id":38996445,"uuid":"397526010","full_name":"rakutentech/laravel-request-docs","owner":"rakutentech","description":"Effortless API documentation tool for Laravel applications. Swagger alternative.","archived":false,"fork":false,"pushed_at":"2026-03-24T10:18:32.000Z","size":3770,"stargazers_count":786,"open_issues_count":8,"forks_count":108,"subscribers_count":21,"default_branch":"master","last_synced_at":"2026-03-25T12:56:15.672Z","etag":null,"topics":["laravel","laravel-api","laravel-documentation","laravel-package","laravel-swagger","laravel-swagger-generator","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rakutentech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-18T08:22:12.000Z","updated_at":"2026-03-24T10:17:10.000Z","dependencies_parsed_at":"2024-02-02T05:40:25.085Z","dependency_job_id":"faa44e5d-d835-4775-8660-285941f371d6","html_url":"https://github.com/rakutentech/laravel-request-docs","commit_stats":{"total_commits":247,"total_committers":19,"mean_commits":13.0,"dds":"0.44534412955465585","last_synced_commit":"e43dfc526dec9174abe0cc4454bdfdf1c1dc2b96"},"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"purl":"pkg:github/rakutentech/laravel-request-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakutentech%2Flaravel-request-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakutentech%2Flaravel-request-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakutentech%2Flaravel-request-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakutentech%2Flaravel-request-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rakutentech","download_url":"https://codeload.github.com/rakutentech/laravel-request-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rakutentech%2Flaravel-request-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31305971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T09:48:21.550Z","status":"ssl_error","status_checked_at":"2026-04-02T09:48:19.196Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","laravel-api","laravel-documentation","laravel-package","laravel-swagger","laravel-swagger-generator","php"],"created_at":"2025-04-10T04:15:55.703Z","updated_at":"2026-04-02T12:01:31.174Z","avatar_url":"https://github.com/rakutentech.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/rakutentech/laravel-request-docs\"\u003e\n    \u003cimg alt=\"Laravel Request Docs\" src=\"https://imgur.com/NuQNx8v.png\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  The Hassle-Free automatic API documentation generation for Laravel.\n  \u003cbr\u003e\n  A Swagger alternative.\n  \u003cbr\u003e\n  Supports Open API 3.0.0\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003cb\u003e\n     \u003ca href=\"https://rakutentech.github.io/laravel-request-docs/?api=https://raw.githubusercontent.com/rakutentech/laravel-request-docs/master/ui/public/sample.json\" target=\"_blank\"\u003eTry latest DEMO!\u003c/a\u003e\n  \u003c/b\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/rakutentech/laravel-request-docs/actions/workflows/node.yml/badge.svg?branch=master\" alt=\"CI Node\"\u003e\n  \u003cimg src=\"https://github.com/rakutentech/laravel-request-docs/actions/workflows/phptest.yml/badge.svg?branch=master\" alt=\"CI PHP\"\u003e\n\u003c/p\u003e\n\n**Fast** Install on any Laravel Project\n\n**Hassle Free** Auto Generate API Documentation for request rules and parameters\n\n**Analyze** Inbuilt SQL query time analyzer, response time and headers output.\n\n**Supports** Postman and OpenAPI 3.0.0 exports.\n\n## Features\n\n- Light and Dark mode\n- Automatic rules fetching from injected Request and by regexp\n- Automatic routes fetching from Laravel Routes\n- Support for Laravel logs\n- Support for SQL query and query time\n- Support for HTTP response time and memory consumption\n- Support for Authorization Headers\n- Support for File uploads\n- Support for Eloquents events\n- Display extra documentation using markdown\n- Saves history previous requests\n- Added filters to sort, group and filter routes by methods, controllers, middlewares, routes\n- Export Laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0\n\n# Read on Medium\n\nAutomatically generate API documentation for Laravel without writing annotations.\n\nRead more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e\n\n## Requirements\n\n| Lang    | Versions                  |\n| :------ |:--------------------------|\n| PHP     | 7.4 or 8.0 or 8.1 or 8.2  |\n| Laravel | 6.* or 8.* or 9.* or 10.* |\n\n# Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require rakutentech/laravel-request-docs\n```\n\n\nYou can publish the config file with:\n\n```bash\nphp artisan vendor:publish --tag=request-docs-config\nphp artisan route:cache\n\n# Optional publish assets\n# php artisan vendor:publish --tag=request-docs-assets\n```\n\n(optional) Add the following middleware to your API, so that the SQL logs and model events are captured.\n\n`app/Http/Kernel.php`\n\n```sh\n        'api' =\u003e [\n            ...\n            \\Rakutentech\\LaravelRequestDocs\\LaravelRequestDocsMiddleware::class,\n            ... and so on\n\n```\n\n# Usage\n\n## Dashboard\n\nView in the browser on ``/request-docs/``\n\n# Design pattern\n\nFor this plugin to work, you need to follow the design pattern by injecting the request class inside the controller.\nFor extra documentation you can use markdown inside your controller method as well.\n\n![Design pattern](https://imgur.com/yXjq3jp.png)\n\n# Screenshots\n\n**Dark and Light Modes**\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://imgur.com/vOMMYVl.png\" width=\"49%\" /\u003e\n  \u003cimg src=\"https://imgur.com/HZvNOFm.png\" width=\"49%\" /\u003e\n\u003c/p\u003e\n\n\n- Uses local storage to save the history of previous requests and request headers.\n- Request, SQL, response and events timeline below:\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://imgur.com/fd09jw1.png\" width=\"32%\" /\u003e\n  \u003cimg src=\"https://imgur.com/8PLLlHv.png\" width=\"45%\" /\u003e\n\u003c/p\u003e\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://imgur.com/q3d7pw2.png\" width=\"49%\" /\u003e\n  \u003cimg src=\"https://imgur.com/AHTCUOJ.png\" width=\"41%\" /\u003e\n\u003c/p\u003e\n\n**Settings to sort, group and filter**\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://imgur.com/SGXlIbl.png\" width=\"30%\" /\u003e\n  \u003cimg src=\"https://imgur.com/Wb2AmZl.png\" width=\"25%\" /\u003e\n\u003c/p\u003e\n\n\n# Extra documentation\n\nYou can write extra documentation in markdown using `@lrd` in the PHPDoc on the `rules` method of the `Request` classes and on the controller methods.\\\nThis will then be rendered as HTML on the dashboard.\\\nDocumentation defined on the controller method is appended below documentation defined on the `rules` method.\\\nExample of using it in the controller:\n\n```php\n    /**\n     * @lrd:start\n     * # Hello markdown\n     * Free `code` or *text* to write documentation in markdown\n     * @lrd:end\n     */\n    public function index(MyIndexRequest $request): Resource\n    {\n```\n\n# Extra parameters\n\nYou define extra parameters using `@LRDparam`.\\\nYou can use `@LRDparam` in PHPDoc on both the `rules` methods and the controller methods.\\\nYou can also overwrite rules using `@LRDparam`.\nMeaning, when rules are defined in the `rules` method, you can overwrite those rules using `@LRDparam` in the PHPDoc above the `rules` method.\nAnd you can overwrite those rules using `@LRDparam` in a PHPDoc on the controller methods.\\\nSo, the precedence is `Controller method PHPDoc` \u003c `Rules method PHPDoc` \u003c `Rules method values`.\n\n```php\n    /**\n     * @LRDparam username string|max:32\n     * // either space or pipe\n     * @LRDparam nickaname string|nullable|max:32\n     * // override the default response codes\n     * @LRDresponses 200|422\n     */\n    public function index(MyIndexRequest $request): Resource\n    {\n```\n\n# Response codes\nWithout explicitly declaring response codes,\nall routes are documented to return any of the response codes defined in the request-docs.php `default_responses` configuration.\\\nHowever, using `@LRDresponse 200|422` (spaces or pipes) within the PHPDoc on your controller methods,\nyou are able to explicitly define what status codes can be returned by the server.\n\n# Configuration\nPlease view the `request-docs.php` config file to see how you can customise your experience.\n\n# Testing\n\n```bash\n./vendor/bin/phpunit\n```\n\n# Linting\n\n```bash\n./vendor/bin/phpcs --standard=phpcs.xml --extensions=php --ignore=tests/migrations config/ src/\n```\n\nFixing lints\n\n```bash\n./vendor/bin/php-cs-fixer fix src/\n./vendor/bin/php-cs-fixer fix config/\n```\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=rakutentech/laravel-request-docs\u0026type=Date)](https://star-history.com/#rakutentech/laravel-request-docs\u0026Date)\n\n# Changelog\n\n- Initial Release\n- v1.9 Added improvements such as status code, response headers, custom request headers and fixed issues reported by users\n- v1.10 Show PHP memory usage, gzip encoding fix\n- v1.12 Bug fix of id, and Laravel 9 support\n- v1.13 Laravel 9 support\n- v1.15 Adds Filter and fall back to regexp upon Exception\n- v1.17 Do not restrict to FormRequest\n- v1.18 Fix where prism had fixed height. Allow the text area resize.\n- v1.18 Updated UI and pushed unit tests\n- v1.19 Exception -\u003e Throwable for type error\n- v1.20 Feature support open api 3.0.0 #10\n- v1.21 Ability to add custom params\n- v1.22 Boolean|File|Image support\n- v1.22 Boolean|File|Image support\n- v1.23 Bug fix for LRD doc block #76\n- v1.27 A few fixes on width and added request_methods\n- v2.0 UI Renewal to React Static\n    - `@QAParam` is now `@LRDparam`\n    - No special changes for users, upgrade to v2.x as usual\n    - Upgrading users will need to republish config\n- v2.1 UI - adds search bar and few alignment fixes on table\n- v2.2 PHP 8.1 and 8.2 support added\n       - Groupby enabled for routes and controllers\n- v2.3 Bug fix for local storage (tabs) and full UI refactored after alpha\n- v2.4 Show version on navbar and curl is using ace editor\n- v2.5 Groupby final fix and local storage clear button. Other UI refactor\n- v2.6 File uploads\n- v2.7 Show activity on Eloquent models\n- v2.8 Show full activity on Eloquent models\n- v2.13 Bug fixes, and nested params support\n- v2.14 Adds path params support\n- v2.16 Top Navbar is fixed\n- v2.19 Publish _astro assets\n- v2.25 `laravel-request-docs:export`  command to export\n- v2.28 Allow extra documentation to be defined on the `rules` method of the Request class. By @Ken-vdE\n- v2.31 Customized title, vup js and PHP to latest. Customized headers. Save response history.\n- v2.40 A few bug fixes.\n- v2.42 Laravel 12 support\n\n\n# Contributors\n\n\n\u003ca href=\"https://github.com/rakutentech/laravel-request-docs/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=rakutentech/laravel-request-docs\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakutentech%2Flaravel-request-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frakutentech%2Flaravel-request-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frakutentech%2Flaravel-request-docs/lists"}