nolikzero/laravel-postman

Export laravel API routes to postman

laravel-postman

This package allows you to export your API routes to a postman import json file, _(*1)

Installation

Install the package via composer, _(*2)

composer require --dev jimenezmaximiliano/laravel-postman, _(*3)

Then add the service provider in config/app.php:, _(*4)

PHP >= 5.5

JimenezMaximiliano\LaravelPostman\LaravelPostmanServiceProvider::class, _(*5)

PHP < 5.5

JimenezMaximiliano\LaravelPostman\LaravelPostmanServiceProvider, _(*6)

Configuration

First, publish the package configuration file:, _(*7)

php artisan vendor:publish, _(*8)

Note: publishing the configuration file is optional, you can use de default package options., _(*9)

Options

apiURL

This is the base URL for your postman routes, _(*10)

default value: config('app.url'), _(*11)

collectionName

This is the postman collection name, _(*12)

default value: the command will ask for it, _(*13)

collectionDescription

This is the postman collection description, _(*14)

default value: the command will ask for it, _(*15)

apiPrefix

This is the prefix by which we identify the routes to export, _(*16)

default value: 'api', _(*17)

skipHEAD

This avoids creating routes for HEAD method, _(*18)

default value: true, _(*19)

exportDirectory

The directory to which the postman.json file will be exported, _(*20)

Usage

Configuring controllers

Add a property to your entity controller like this:, _(*21)

public $postmanModel = 'App\MyEntityModel';, _(*22)

Add a public method to your model class like this:

public function getPostmanParams() { return $this->fillable; }, _(*23)

This array of params will be used to fill POST and PUT urlencoded form data section in postman. The previous method is just an example, you should return the array of params that you want to see in postman., _(*24)

Export

php artisan laravelPostman:export, _(*25)