PHPackages                             vince/postman-generator-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. vince/postman-generator-bundle

Abandoned → [api-platform/postman-collection-generator](/?search=api-platform%2Fpostman-collection-generator)ArchivedSymfony-bundle

vince/postman-generator-bundle
==============================

Generator for Postman collection based on API Platform 1.\*

30128[1 PRs](https://github.com/vincentchalamon/PostmanGeneratorBundle/pulls)PHP

Since Mar 11Pushed 9y ago9 watchersCompare

[ Source](https://github.com/vincentchalamon/PostmanGeneratorBundle)[ Packagist](https://packagist.org/packages/vince/postman-generator-bundle)[ RSS](/packages/vince-postman-generator-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

PostmanGeneratorBundle
======================

[](#postmangeneratorbundle)

**This bundle is not necessary anymore if you use API Platform 2.0 or superior.** API Platform now supports natively [Swagger](http://swagger.io/) and Postman is able to create collections from a Swagger documentation.

Generator for [Postman](https://www.getpostman.com) collection based on [API Platform](https://api-platform.com/).

[![Build Status](https://camo.githubusercontent.com/544828dc3b65b5d7097625bc5e4da99f1fde2735bdd2766ff1a482c42e2fcd91/68747470733a2f2f7472617669732d63692e6f72672f6170692d706c6174666f726d2f706f73746d616e2d636f6c6c656374696f6e2d67656e657261746f722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/api-platform/postman-collection-generator)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/0228e36a28dc3a01fd9ecb623e129b124bb2a57c7f6c27b0f8f74c207f689955/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6170692d706c6174666f726d2f706f73746d616e2d636f6c6c656374696f6e2d67656e657261746f722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/api-platform/postman-collection-generator/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/19c6aaa5662142fcf62c1ab66d1ff0abbc625244a1aff6c016f8e73932c7cee1/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6170692d706c6174666f726d2f706f73746d616e2d636f6c6c656374696f6e2d67656e657261746f722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/api-platform/postman-collection-generator/?branch=master)[![SensioLabsInsight](https://camo.githubusercontent.com/38b95ca6b22210d1b99a881441c43468170df987b97a9bb4a18c95dc553dc87a/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f32383163656333322d643564632d346166652d396165652d3861373034663130323566392f6d696e692e706e67)](https://insight.sensiolabs.com/projects/281cec32-d5dc-4afe-9aee-8a704f1025f9)[![Dependency Status](https://camo.githubusercontent.com/5f4d43c066bdbf3feed523b685da96a801b6b4644b2293814b836647adf38b56/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3536643164346233313537613639303032656139353666372f62616467652e7376673f7374796c653d666c6174)](https://www.versioneye.com/user/projects/56d1d4b3157a69002ea956f7)

Installation
------------

[](#installation)

Install this bundle through [Composer](https://getcomposer.org/):

```
composer require --dev api-platform/postman-collection-generator
```

Using Symfony, update your `AppKernel.php` file:

```
public function registerBundles()
{
    ...
    if ($this->getEnvironment() != 'prod') {
        ...
        $bundles[] = new PostmanGeneratorBundle\PostmanGeneratorBundle();
    }
}
```

Configuration
-------------

[](#configuration)

This library requires some configuration. Edit your `app/config_dev.yml` file as following:

```
postman_generator:
    name: Name of your API                  # Required
    description: Description of your API    # Optional, default: null
    baseUrl: http://www.example.com         # Required
    public: false                           # Optional, default: false
    authentication: oauth2                  # Optional, default: null
    defaultLocale: fr_FR                    # Optional, default: en_GB
```

Usage
-----

[](#usage)

This bundle provides a unique command to automatically generate a Postman collection based on your API Platform project configuration. Run `php app/console postman:collection:build --help` for more details.

Use parsers
-----------

[](#use-parsers)

This library provides a simple way to extend it, called `parsers`. There are 2 of them: request parsers & command parsers.

### Request parsers

[](#request-parsers)

Request parsers are services executed to edit [Postman requests](src/Model/Request.php) before being sent to collection. You can, for example, add a custom authentication header, add some tests, etc.

To create your own request parser, your service must implement `PostmanGeneratorBundle\RequestParser\RequestParserInterface`, and has a tag `postman.request_parser`.

**Careful**: some request parsers may be executed before yours. Check for [`priority`](http://symfony.com/doc/current/reference/dic_tags.html)process in Symfony Dependency Injection.

### Command parsers

[](#command-parsers)

Command parsers are services executed to connect to the main command, for example to ask for authentication access.

To create your own command parser, your service must implement `PostmanGeneratorBundle\CommandParser\CommandParserInterface`, and has a tag `postman.command_parser`. `parse` method allows you to ask questions to user, and `execute` method to do your stuff.

**Careful**: some command parsers may be executed before yours. Check for [`priority`](http://symfony.com/doc/current/reference/dic_tags.html)process in Symfony Dependency Injection.

Authentication
--------------

[](#authentication)

By default, this library can manage [OAuth2](http://oauth.net/2/) authentication. To use it, fill `authentication`configuration key using `oauth2`. When using main command, you will be prompt for some login/password. They will be managed as environment variables in Postman.

Feel free to add your own authenticators as request & command parsers.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 88.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/407859?v=4)[Vincent](/maintainers/vincentchalamon)[@vincentchalamon](https://github.com/vincentchalamon)

---

Top Contributors

[![vincentchalamon](https://avatars.githubusercontent.com/u/407859?v=4)](https://github.com/vincentchalamon "vincentchalamon (30 commits)")[![dunglas](https://avatars.githubusercontent.com/u/57224?v=4)](https://github.com/dunglas "dunglas (3 commits)")[![mattpramschufer](https://avatars.githubusercontent.com/u/4295444?v=4)](https://github.com/mattpramschufer "mattpramschufer (1 commits)")

### Embed Badge

![Health badge](/badges/vince-postman-generator-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/vince-postman-generator-bundle/health.svg)](https://phpackages.com/packages/vince-postman-generator-bundle)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)