How do you sync Postman with a git repository

Postman

Postman Problem Overview


I'm wondering how you can sync your Postman config with a git repository.

I know you can export and import from Postman to a folder - which is OK - but I wondered if there was something more effortless.

Postman Solutions


Solution 1 - Postman

I'm not exactly sure how you're trying to use this, but a few options would be:

First Option

to use their addon cli called newman. You can run collections from a URL or Local file with newman using

newman run http://some.url.here

Then if you make the remote url a part of a git repository it would obviously update/change with each commit/pull

Second Option

Try this with extreme caution and only if you feel comfortable with the process, also this may not be compliant with their terms of use so I don't suggest you try it without first some research

If you can find the directory in which the Postman collections are held, you could create a hard link with the command line from a git repository on your machine to the directory or specific file you need to link. Whenever you change the source file the one in the Postman config will change.

The way in which you accomplish this will depend on the system you use and version of Postman.

Solution 2 - Postman

In addition to exporting and cloud syncing as mentioned in the other answers, there's some other options too.

> Postman added a Git sync in Postman app v9 so you can manage version control with forking, merging, and pull requests.

  • There are also built-in integrations to sync your Postman collections with GitHub, with GitLab, and other services for version control. These integrations are for users on the paid plans.
  • Postman also has an API so you can GET and run the latest version of your collection, environment, or whatever using Newman or continuous integration tools or to build your own integration.

Solution 3 - Postman

You can use Postman integrations (Home > Integrations) to link Postman to your remote git repository.

The following article explains how to integrate your gitlab repo to Postman: https://learning.postman.com/docs/integrations/available-integrations/gitlab/

Also you can use Postman API versionning to do something similar: https://learning.postman.com/docs/designing-and-developing-your-api/versioning-an-api/

Solution 4 - Postman

Postman is not designed for that case. They offer a cloud service which keeps you and your collaborators in sync. You can try their cloud plan for 30 days for free. Check here: https://www.getpostman.com/cloud_trial_faq

Solution 5 - Postman

For non-free plans, Postman now (version 9 and up) supports automatic sync of collections with a git repository on several popular git services.

(Again, it's currently only available for paid plans)

See the documentation for how to integrate Postman with GitHub, GitLab and Bitbucket.

The process is roughly:

  • create a dedicated repo on your git provider (e.g. my-postman-collections-repo)
  • create a personal access token for the provider (e.g. GitHub) with the expected scope (e.g. repo and user)
  • define an integration (using postman UI) for each collection you want to be kept in sync

I'm working with the GitHub integration and it works great.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionmeh-ukView Question on Stackoverflow
Solution 1 - PostmanDanielCView Answer on Stackoverflow
Solution 2 - PostmanJ.LinView Answer on Stackoverflow
Solution 3 - PostmanelkolotfiView Answer on Stackoverflow
Solution 4 - PostmanSergej LopatkinView Answer on Stackoverflow
Solution 5 - PostmanGilad Bar OrionView Answer on Stackoverflow