{"id":15013854,"url":"https://github.com/andreaselia/laravel-api-to-postman","last_synced_at":"2025-05-13T22:03:22.687Z","repository":{"id":38274842,"uuid":"323709695","full_name":"andreaselia/laravel-api-to-postman","owner":"andreaselia","description":"Generate a Postman collection automatically from your Laravel API","archived":false,"fork":false,"pushed_at":"2025-02-26T20:53:16.000Z","size":284,"stargazers_count":988,"open_issues_count":0,"forks_count":102,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-29T13:41:31.138Z","etag":null,"topics":["api","collection","generator","insomnia","laravel-package","postman","route"],"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/andreaselia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["andreaselia","tomirons"]}},"created_at":"2020-12-22T18:58:33.000Z","updated_at":"2025-04-25T18:13:38.000Z","dependencies_parsed_at":"2024-03-06T13:29:02.445Z","dependency_job_id":"7229a01b-ef8a-405a-8045-bf13a7ca44c4","html_url":"https://github.com/andreaselia/laravel-api-to-postman","commit_stats":{"total_commits":254,"total_committers":20,"mean_commits":12.7,"dds":0.5354330708661417,"last_synced_commit":"977c451e67393ab1c78a1ceb01496e264113806c"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreaselia%2Flaravel-api-to-postman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreaselia%2Flaravel-api-to-postman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreaselia%2Flaravel-api-to-postman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreaselia%2Flaravel-api-to-postman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreaselia","download_url":"https://codeload.github.com/andreaselia/laravel-api-to-postman/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254036811,"owners_count":22003653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","collection","generator","insomnia","laravel-package","postman","route"],"created_at":"2024-09-24T19:44:51.446Z","updated_at":"2025-05-13T22:03:22.662Z","avatar_url":"https://github.com/andreaselia.png","language":"PHP","funding_links":["https://github.com/sponsors/andreaselia","https://github.com/sponsors/tomirons"],"categories":[],"sub_categories":[],"readme":"![Laravel API to Postman Header](/header.png)\n\n[![Latest Stable Version](https://poser.pugx.org/andreaselia/laravel-api-to-postman/v)](//packagist.org/packages/andreaselia/laravel-api-to-postman)\n[![StyleCI](https://github.styleci.io/repos/323709695/shield?branch=master)](https://github.styleci.io/repos/323709695?branch=master)\n\n# Laravel API to Postman\n\nThis package allows you to automatically generate a Postman collection based on your API routes. It also provides basic configuration and support for bearer auth tokens and basic auth for routes behind an auth middleware.\n\nFor ```POST``` and ```PUT``` requests that utilizes a FormRequest, you can optionally scaffold the request, and publish rules in raw or human readable format.\n## Postman Schema\n\nThe generator works for the latest version of the Postman Schema at the time of publication (v2.1.0).\n\n## Installation\n\nInstall the package:\n\n```bash\ncomposer require andreaselia/laravel-api-to-postman\n```\n\nPublish the config file:\n\n```bash\nphp artisan vendor:publish --provider=\"AndreasElia\\PostmanGenerator\\PostmanGeneratorServiceProvider\"\n```\n\n## Configuration\n\nYou can modify any of the `api-postman.php` config values to suit your export requirements.\n\nClick [here](/config/api-postman.php) to view the config attributes.\n\n## Usage\n\nThe output of the command being ran is your storage/app directory.\n\nTo use the command simply run:\n\n```bash\nphp artisan export:postman\n```\n\nThe following usage will generate routes with the bearer token specified.\n\n```bash\nphp artisan export:postman --bearer=\"1|XXNKXXqJjfzG8XXSvXX1Q4pxxnkXmp8tT8TXXKXX\"\n```\n\nThe following usage will generate routes with the basic auth specified.\n\n```bash\nphp artisan export:postman --basic=\"username:password123\"\n```\n\nIf both auths are specified, bearer will be favored.\n\n## Examples\n\nThis is with the default configuration and a bearer token passed in:\n\n```bash\nphp artisan export:postman --bearer=123456789\n```\n\n- [Example routes](/examples/api.php)\n- [Example default output](/examples/2021_02_04_151948_postman.json)\n- [Example structured output](/examples/2021_02_04_155327_postman.json)\n\n## Contributing\n\nYou're more than welcome to submit a pull request, or if you're not feeling up to it - create an issue so someone else can pick it up.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreaselia%2Flaravel-api-to-postman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreaselia%2Flaravel-api-to-postman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreaselia%2Flaravel-api-to-postman/lists"}