halimzidoune/laravel-postman-api

This package allow to export all API routes from your laravel project to be used in postman and make tests manualy.

v1.0.3 2023-04-21 22:01 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

With this command: php artisan routes:export collection_name, a json file will be generated and can be imported from postman, for a good separation between the API modules, folders and subfolders tree will be generated , this division is based on the paths of the urls.

In POST and PUT Methods, if the controller action use a FormRequest, all rules attributes will be extracted and created in postman body request.

laravel-api-to-postman-featured.png

Installation

You can install the package via composer:

composer require halimzidoune/laravel-postman-api

You can publish the config file with:

php artisan vendor:publish --tag="postman-api-config"

This is the contents of the published config file:

return [
    'base_url' => 'http://localhost:8000', // API Host url
    'export_folder' => 'postman', // The destination folder where the collection.json file will be generated
];

Usage

php artisan routes:export collection_name

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.