Postman
Postman is a popular API platform used for building, testing, and documenting APIs. It provides a user-friendly interface to send requests, inspect responses, and streamline the entire API lifecycle, from design and mocking to automated testing and collaboration.
2012
3
Definitions
Postman as an API Client
In its most fundamental role, Postman acts as an API client. It provides a user-friendly graphical interface for creating, sending, and viewing HTTP/S requests and responses. Users can easily construct complex requests, including GET, POST, PUT, DELETE, and others, without writing any code.
Key features in this context include setting request URLs, methods, headers, query parameters, and authorization credentials. It also simplifies adding request bodies in various formats like JSON, form-data, x-www-form-urlencoded, and raw text. The response from the server is then neatly displayed, showing the status code, headers, and a formatted response body, which is invaluable for debugging.
Postman as an API Development and Testing Platform
Beyond being a simple client, Postman is a comprehensive platform for the entire API lifecycle. It allows developers to organize requests into 'Collections', which are executable groups of API calls. These collections can be run automatically using the 'Collection Runner' to perform integration or regression testing.
It supports 'Environments' and 'Variables', allowing users to switch contexts (e.g., from a local development server to a production server) seamlessly by changing variables like base URLs or API keys. Furthermore, developers can write JavaScript-based test scripts within Postman to validate API responses, checking for correct status codes, data formats, and values, thereby automating the API testing process.
Postman as a Collaborative API Platform
Postman excels as a collaborative tool that streamlines teamwork in API development. It uses 'Workspaces' to create shared environments where teams can work on the same collections, environments, and documentation in real-time. This ensures that all team members, from backend developers to frontend developers and QA engineers, are synchronized.
Features like commenting, forking, and pull requests for collections mimic version control systems like Git, facilitating controlled changes and reviews. Postman can also automatically generate and host API documentation from a collection and create mock servers. Mock servers simulate an API's behavior before it's actually built, enabling parallel development between frontend and backend teams.
Origin & History
Etymology
The name 'Postman' is a metaphor for its function. In the same way a mail carrier (a postman) delivers a message (a letter) and sometimes brings back a reply, the software 'delivers' an API request to a server and 'brings back' a response.
Historical Context
In the early days of web development, interacting with APIs was often done through command-line tools like cURL or by writing custom scripts. While powerful, these methods were often cumbersome, lacked a user-friendly interface, and made it difficult to save and organize API calls for reuse. As RESTful APIs became the standard for web services, the need for better tooling grew. In 2012, software engineer Abhinav Asthana created **Postman** as a side project to solve these challenges. It started as a free REST client extension for the Google Chrome browser and quickly gained popularity for its simplicity and intuitive GUI. Recognizing its potential, Abhinav Asthana, along with Ankit Sobti and Abhijit Kane, founded Postman, Inc. in 2014. They expanded the tool from a simple Chrome extension into a standalone, native application for all major operating systems. Over the years, it evolved from a basic API client into a comprehensive, collaborative platform for the entire API lifecycle, incorporating features like testing, documentation, mock servers, and team workspaces. Today, it is an industry-standard tool used by millions of developers worldwide.
Usage Examples
To test the new user endpoint, I'll just create a request in Postman and check the response.
The development team uses a shared Postman collection to ensure everyone is working with the latest API specifications.
Instead of using cURL, she preferred the graphical interface of the API Client to debug the authentication issue.
We've automated our regression tests using the Postman Collection Runner, which integrates directly into our CI/CD pipeline.
Frequently Asked Questions
What is the primary purpose of a Postman Collection?
A Postman Collection is a group of saved API requests. Its primary purpose is to organize related requests together, such as all the endpoints for a specific feature or service. This makes them easy to run, test, share, and document as a single unit.
How does Postman differentiate between different deployment stages like development, staging, and production?
Postman uses 'Environments' to manage configurations for different stages. An environment is a set of key-value pairs (variables), like base URLs or API keys. By switching the active environment, a developer can run the same set of requests against the development, staging, or production servers without modifying the requests themselves.
Can Postman be used for more than just sending requests?
Yes, absolutely. While its core function is as an API client, Postman is a comprehensive platform. It includes powerful features for automated testing (using JavaScript assertions), creating mock servers, generating API documentation, and collaborating with team members through shared workspaces.