https://github.com/andreaselia/laravel-api-to-postman

Generate a Postman collection automatically from your Laravel API
https://github.com/andreaselia/laravel-api-to-postman

api collection generator insomnia laravel-package postman route

Last synced: 7 days ago
JSON representation

Generate a Postman collection automatically from your Laravel API

• Host: GitHub
• URL: https://github.com/andreaselia/laravel-api-to-postman
• Owner: andreaselia
• License: mit
• Created: 2020-12-22T18:58:33.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-23T15:34:18.000Z (6 months ago)
• Last Synced: 2025-01-07T17:06:05.271Z (14 days ago)
• Topics: api, collection, generator, insomnia, laravel-package, postman, route
• Language: PHP
• Homepage:
• Size: 293 KB
• Stars: 967
• Watchers: 20
• Forks: 99
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![Laravel API to Postman Header](/header.png)

[![Latest Stable Version](https://poser.pugx.org/andreaselia/laravel-api-to-postman/v)](//packagist.org/packages/andreaselia/laravel-api-to-postman)

[![StyleCI](https://github.styleci.io/repos/323709695/shield?branch=master)](https://github.styleci.io/repos/323709695?branch=master)

# 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:

```bash

composer require andreaselia/laravel-api-to-postman

```

Publish the config file:

```bash

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](/config/api-postman.php) to view the config attributes.

## Usage

The output of the command being ran is your storage/app directory.

To use the command simply run:

```bash

php artisan export:postman

```

The following usage will generate routes with the bearer token specified.

```bash

php artisan export:postman --bearer="1|XXNKXXqJjfzG8XXSvXX1Q4pxxnkXmp8tT8TXXKXX"

```

The following usage will generate routes with the basic auth specified.

```bash

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:

```bash

php artisan export:postman --bearer=123456789

```

- [Example routes](/examples/api.php)

- [Example default output](/examples/2021_02_04_151948_postman.json)

- [Example structured output](/examples/2021_02_04_155327_postman.json)

## Contributing

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.