Download the PHP package hopheartsceo/laravel-postman-exporter without Composer

Laravel Postman Exporter

Automatically generate Postman Collection v2.1 files and OpenAPI 3.0 specifications from your Laravel application routes, controllers, and FormRequest validations — complete with folder grouping and response examples.

Features

• Route Scanning — Automatically reads all registered API routes
• Request Analysis — Extracts validation rules from FormRequest classes and inline $request->validate() calls
• Context-Aware FormRequests — Evaluates rules with the actual HTTP method, route name, route parameters, and container-injected dependencies
• API Contract Guard — Detects breaking request and response changes and returns a failing exit code for CI
• Example Data Generation — Generates realistic sample values based on validation rules and field names
• Authentication Detection — Automatically adds auth headers based on middleware (Sanctum, Passport, etc.)
• Folder Grouping — Organizes requests into folders based on route prefixes
• Response Examples — Extracts response structures from PHPDoc, API Resources, response()->json(), and Eloquent models
• Response Contract Analysis — Builds OpenAPI schemas from Laravel API Resources, including conditional fields, nested resources, collections, pagination, and top-level metadata
• Multi-Response Contracts — Captures multiple response branches/status codes and Laravel's default validation 422 contract
• Response Pipeline Tracing — Statically follows controller, trait, inherited, and static response helpers to discover wrapped payloads and status codes without executing endpoints
• OpenAPI Support — Export your API as a valid OpenAPI 3.0.3 specification
• Postman Upload — Optionally upload generated Postman collections directly via the Postman API
• Artisan Command — Beautiful CLI with progress indicators and colored output

Installation

You can install the package via composer:

Installation from GitHub (Development)

If you haven't published to Packagist yet, add this to your composer.json:

Publish the configuration file:

Usage

Artisan Command

Facade API

Configuration

After publishing, edit config/postman-exporter.php:

Folder Grouping

Routes are grouped into flat, single-level folders by the first segment of the URI. No nesting is created — every route belongs to exactly one top-level folder.

How it works:

• The first segment of the URI (explode('/', $uri)[0]) becomes the folder name.
• Routes whose first segment is empty or a parameter (e.g. {id}) go to the fallback folder.
• There are no root-level requests — every request lives inside a folder.
• There are no nested folders — the structure is always flat.

Response Examples

Response examples are extracted automatically from your controller methods and attached to each Postman request item.

Or enable at export time with the --with-responses flag:

Response discovery sources:

The exporter combines distinct HTTP status codes from multiple sources instead of stopping at the first match. When two sources describe the same status, the earlier explicit source wins.

1. PHPDoc @response — Parses one or more @response tags with optional status codes:

2. API Resource — Detects direct Resource returns and builds response schemas from the Resource's toArray() structure.

3. Direct Laravel responses — Parses inline response()->json([...], 200) and response()->noContent() returns, including their status codes.

4. Response Pipeline Tracing — Follows custom $this->helper(...), inherited/trait helpers, and static response helper methods until it reaches response()->json(...) or response()->noContent().

5. Eloquent Model — Detects return User::find(...) patterns and generates example data from the model's $fillable fields.

6. Fallback — Uses the configured fallback status and body. By default, the body is null so unknown responses are not documented as fabricated success payloads.

Response pipelines are analyzed statically. Controller endpoints and response helpers are not executed during export or contract checks.

When validation rules are detected, the exporter also adds Laravel's default JSON 422 validation-error contract. This inference is skipped when a FormRequest overrides failedValidation(), and it can be disabled with responses.framework_validation_errors.

Generated response format in Postman:

Route Filters

Middleware to Headers Map

Example Output

The generated collection follows the Postman Collection v2.1 schema. Folders are flat (single-level) and each request includes response examples:

See examples/sample-collection.json for a full example with multiple folders and response examples.

🧪 Testing

🏗️ Architecture

Requirements

• PHP 8.1+
• Laravel 10, 11, or 12

License

MIT License. See LICENSE for details.