Laravel API to Postman
This 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.
For POST and PUT requests that utilizes a FormRequest, you can optionally scaffold the request, and publish rules in raw or human readable format.
Postman Schema
The generator works for the latest version of the Postman Schema at the time of publication (v2.1.0).
Installation
Install the package:
composer require andreaselia/laravel-api-to-postmanPublish the config file:
php artisan vendor:publish --provider="AndreasElia\PostmanGenerator\PostmanGeneratorServiceProvider" --tag="postman-config"Configuration
You can modify any of the api-postman.php config values to suit your export requirements.
Click here to view the config attributes.
Usage
The output of the command being ran is your storage/app directory.
To use the command simply run:
php artisan export:postmanThe following usage will generate routes with the bearer token specified.
php artisan export:postman --bearer="1|XXNKXXqJjfzG8XXSvXX1Q4pxxnkXmp8tT8TXXKXX"The following usage will generate routes with the basic auth specified.
php artisan export:postman --basic="username:password123"If both auths are specified, bearer will be favored.
Examples
This is with the default configuration and a bearer token passed in:
php artisan export:postman --bearer=123456789Contributing
You'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.