galter / laravel-postman-export-onepulse
Export your Laravel routes to a Postman collection .json file
1.0.11
2022-08-02 15:31 UTC
Requires
- dingo/api: 0.10.*
- ramsey/uuid: ^3
README
Updates:
- It's a Package created with Dingo Router to OnePulse internal use. Fork and rewrite as you wish.
- Postman collection scheme
- Artisan consol commands
- Can post project URL address via console
- Basic file name change to postman_collection.json
- Exporting @descriptions / @desc / @des
- Exporting @params
Installation
Install via composer:
composer require --dev galter/laravel-postman-export-onepulse
Add the service provider to your providers
array in config/app.php
galter\LaravelPostmanExportOnePulse\PostmanServiceProvider::class,
That's all!
Usage
php artisan postman:export
This will create a postman_collection.json
inside your storage/app
folder. You are free to change the name of the file by specifying the filename as follows:
php artisan postman:export --name=MyAppName --api
phpdoc Code rules
@var
`class Foo { /**
- @var string $name Should contain a description
- @var string $description Should contain a description */ protected $name, $description; }`
@param
` /**
- Counts the number of items in the provided array.
- @param mixed[] $items Array structure to count the elements of.
- @return int Returns the number of elements. */ function count(array $items) { <...> } `
@return
`/**
- @return integer Indicates the number of items. */ function count() { <...> }`