{"id":48532123,"url":"https://github.com/piovezanfernando/laravel-api-auto-docs","last_synced_at":"2026-04-08T00:03:58.266Z","repository":{"id":328396762,"uuid":"1115418266","full_name":"piovezanfernando/laravel-api-auto-docs","owner":"piovezanfernando","description":"Automatically generate Laravel API documentation from request rules, controllers and routes","archived":false,"fork":false,"pushed_at":"2026-03-26T18:36:26.000Z","size":1041,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-03-27T07:49:41.961Z","etag":null,"topics":["api-documentation","auto-documentation","laravel","laravel-api-auto-docs","laravel-request","open-source","php8"],"latest_commit_sha":null,"homepage":"https://piovezanfernando.github.io/laravel-api-auto-docs/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piovezanfernando.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":"2025-12-12T20:45:45.000Z","updated_at":"2026-03-26T18:34:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/piovezanfernando/laravel-api-auto-docs","commit_stats":null,"previous_names":["piovezanfernando/laravel-api-auto-docs"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/piovezanfernando/laravel-api-auto-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piovezanfernando%2Flaravel-api-auto-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piovezanfernando%2Flaravel-api-auto-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piovezanfernando%2Flaravel-api-auto-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piovezanfernando%2Flaravel-api-auto-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piovezanfernando","download_url":"https://codeload.github.com/piovezanfernando/laravel-api-auto-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piovezanfernando%2Flaravel-api-auto-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31053461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-27T16:55:14.406Z","status":"ssl_error","status_checked_at":"2026-03-27T16:55:07.885Z","response_time":164,"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":["api-documentation","auto-documentation","laravel","laravel-api-auto-docs","laravel-request","open-source","php8"],"created_at":"2026-04-08T00:03:57.786Z","updated_at":"2026-04-08T00:03:58.260Z","avatar_url":"https://github.com/piovezanfernando.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravel API Auto Docs\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/license-MIT-green.svg\" alt=\"License MIT\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/php-8.4%2B-green\" alt=\"PHP 8.4+\"\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 with modern Vue 3 interface.\n  \u003cbr\u003e\n  Supports Open API 3.0.0\n\u003c/p\u003e\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 analysis\n- ⚡ Support for memory consumption\n- 🔐 Support for Authorization Headers\n- 🎯 Support for Eloquent events\n- 🔄 Support for OpenAPI 3.0.0 exports\n- 🎨 Modern Vue 3 interface\n\n## Requirements\n\n- PHP \u003e= 8.3\n- Laravel 11.x | 12.x | 13.x\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require piovezanfernando/laravel-api-auto-docs\n```\n\nPublish the config file:\n\n```bash\nphp artisan vendor:publish --tag=\"api-auto-docs-config\"\n```\n\n## Configuration\n\nThe configuration file will be published to `config/api-auto-docs.php`. Here you can configure:\n\n- Routes to document\n- Middleware to apply\n- UI customizations\n- And more...\n\n## Usage\n\n### Accessing the Documentation\n\nBy default, the documentation is available at:\n\n```\nhttp://your-app.test/docs-api\n```\n\n### Generating OpenAPI Specification\n\nTo generate the OpenAPI specification file:\n\n```bash\nphp artisan api-docs:export\n```\n\nThis will create an `api.json` file in your project's root directory by default. You can specify a different path:\n\n```bash\nphp artisan api-docs:export storage/app/api.json\n```\n\n### Adding Descriptions to Controllers\n\nThe package automatically reads the summary and description from your controller methods' PHPDoc comments.\n\n```php\nclass UserController extends Controller\n{\n    /**\n     * Create a new user.\n     *\n     * This endpoint allows you to create a new user in the system.\n     * The user's name, email, and password are required.\n     */\n    public function store(CreateUserRequest $request)\n    {\n        // Your code here\n    }\n}\n```\n\n### Request Validation\n\nThe package automatically reads Laravel FormRequest validation rules:\n\n```php\nclass CreateUserRequest extends FormRequest\n{\n    public function rules()\n    {\n        return [\n            'name' =\u003e 'required|string|max:255',\n            'email' =\u003e 'required|email|unique:users',\n            'password' =\u003e 'required|string|min:8',\n        ];\n    }\n}\n```\n\n## Configuration Options\n\n### Exclude Routes\n\nIn `config/api-auto-docs.php`:\n\n```php\n'hide_matching' =\u003e [\n    '#^api/internal#',\n    '#^_debugbar#',\n],\n```\n\n### Middleware\n\n```php\n'middlewares' =\u003e [\n    'web',\n    'auth', // Add if you want authentication\n],\n```\n\n### UI Customization\n\n```php\n'title' =\u003e 'My API Documentation',\n'default_headers' =\u003e [\n    'Content-Type' =\u003e 'application/json',\n    'Accept' =\u003e 'application/json',\n],\n```\n\n## Testing Your API\n\nThe built-in UI allows you to:\n- 📤 Send requests directly from the browser\n- 📊 View SQL queries and memory usage\n- 📋 See logs and debug information\n- 💾 Export to OpenAPI format\n\n## Export Options\n\n### OpenAPI 3.0\n\nAccess the OpenAPI specification:\n```\nhttp://your-app.test/docs-api/api?openapi=true\n```\n\nDownload the JSON representation via:\n```\nhttp://your-app.test/docs-api/api?json=true\n```\n\n## Security\n\nIf you want to restrict access to the documentation:\n\n```php\n// config/api-auto-docs.php\n'middlewares' =\u003e [\n    'web',\n    'auth',\n    'can:view-api-docs', // Custom gate\n],\n```\n\n### Credits\n\nThis package is based on the excellent work from  \n[Laravel Request Docs](https://github.com/rakutentech/laravel-request-docs) by Rakuten Tech.\n\nAll credit for the original idea and implementation goes to  \nPulkit Kathuria and the Rakuten Tech engineering team.\n\nThis fork extends the original project with additional features, UI redesign,\nand ongoing maintenance, while preserving the MIT license.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n## Support\n\n- **Issues**: [GitHub Issues](https://github.com/piovezanfernando/laravel-api-auto-docs/issues)\n- **Original Project**: [Laravel Request Docs](https://github.com/rakutentech/laravel-request-docs)\n\n## Colaboradores\n\n\u003ca href=\"https://github.com/piovezanfernando/laravel-api-auto-docs/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=piovezanfernando/laravel-api-auto-docs\"  alt=\"\"/\u003e\n\u003c/a\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiovezanfernando%2Flaravel-api-auto-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiovezanfernando%2Flaravel-api-auto-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiovezanfernando%2Flaravel-api-auto-docs/lists"}