Skip to content
This repository

Postman helps you be more efficient while working with APIs. Using Postman, you can construct complex HTTP requests quickly, organize them in collections and share them with your co-workers.

README.md

Quick links

About Postman

Postman helps you be more efficient while working with APIs. Postman is a scratch-your-own-itch project. The need for it arose while one of the developers was creating an API for his project. After looking around for a number of tools, nothing felt just right. The primary features added were a history of sent requests and collections. A number of other features have been added since the initial release. A small list is below. To see a fancier page and a video tutorial, check out http://www.getpostman.com

Features

Create requests quickly.

  • Compact layout
  • HTTP requests with file upload support
  • Formatted API responses for JSON and XML
  • HATEOAS support
  • Image previews
  • Request history
  • Basic Auth and OAuth 1.0 helpers
  • Autocomplete for URL and header values
  • Key/value editors for adding parameters or header values. Works for URL parameters too.
  • Use environment variables to easily shift between settings. Great for testing production, staging or local setups.
  • Keyboard shortcuts to maximize your productivity

Document and share APIs.

  • Use collections to organize requests.
  • Document requests inside collections. You can even store entire HTML notes. Postman uses Bootstrap so you can use it too to style your notes.
  • Download and share collections with your team of developers.

Installing the zip file

If you downloaded the Postman zip file here is what you need to do to install it as a developer extension:

  1. Go to Tools > Extensions inside Chrome by clicking on the wrench icon on top right.
  2. Select "Load unpacked extension"
  3. Select the "chrome" folder with manifest.json in it's root
  4. Postman will be installed as a developer extension. The installation from the Chrome Web Store will remain independent with all your data.

Building and Developing

  1. Install the dependencies
    sudo npm install -g grunt grunt-cli
    
  2. Generate the template.js and request.js files by running grunt. You can watch the folder for changes using:
    grunt watch
    
  3. For misc. grunt tasks, look at grunt.js.

Submitting bugs

Please add the Postman version along with your operating system and Chrome version along with bug requests.

Something went wrong with that request. Please try again.