Skip to content
Postman API Testing Tips

How To Use Postman Desktop App

API Testing Blog

Getting Started with Postman: Your Ultimate Guide to API Testing

Postman is an indispensable tool for API testing, offering a user-friendly interface and powerful features to streamline your workflow. Let’s dive into the basics of using the Postman desktop app.

Installing and Launching Postman

  1. Download and install: Visit the Postman website (https://www.postman.com/) and download the desktop app for your operating system.
  2. Launch Postman: Once installed, open the application. You’ll be greeted with the Postman workspace.

Creating a New Request

Let’s start by creating a request to a popular API like the “JSONPlaceholder” API, which provides fake data for testing purposes.

  1. Select HTTP Method: In the top left corner, choose the appropriate HTTP method for your request. For this example, let’s use “GET” for fetching data.
  2. Enter Request URL: In the address bar, enter the API endpoint URL. For this example, use: https://jsonplaceholder.typicode.com/posts
  3. Send Request: Click the “Send” button to execute the request.

Result: The response from the API will be displayed in the “Body” tab with the list of posts in JSON format.

Understanding the Request Builder

Postman offers a comprehensive request builder with various features for crafting and customizing your requests:

  • Headers: Add custom headers to your request, like “Authorization” for authentication.
  • Body: Select the body type based on your API requirements (form data, JSON, raw text, etc.).
  • Authorization: Configure authentication mechanisms like API keys, basic auth, OAuth 2.0, etc.
  • Pre-request Script: Run JavaScript code before sending the request for pre-request actions.
  • Tests: Write tests using JavaScript code to verify the response data against expected values.

Sending Requests with Parameters

Many APIs require parameters to filter or modify the data returned. Let’s add a parameter to the “JSONPlaceholder” API to get a specific post.

  1. Add Parameter: In the “Params” tab, add a new parameter “id” with the value “1”.
  2. Send Request: Click “Send” to execute the request with the added parameter.

Result: The response body will now display the details of the post with ID “1”.

Creating Collections and Environments

To organize your requests and manage API data efficiently, use collections and environments.

  • Collections: Group related requests together, such as all GET requests, POST requests, etc.
  • Environments: Store variables, such as API keys, base URLs, or other configuration details, to easily switch between different environments.

Example:

  1. Create Collection: Click “New Collection” and give it a name (e.g., “JSONPlaceholder”).
  2. Add Request: Add the previous GET request to the collection.
  3. Create Environment: Click “New Environment” and name it (e.g., “Development”).
  4. Add Variables: Add variables like “baseUrl” with the value “https://jsonplaceholder.typicode.com”.
  5. Use Variable: In your request URL, replace the fixed URL with {{baseUrl}}/posts/1 to reference the variable.

Writing Tests in Postman

Postman’s testing feature allows you to validate API responses against expected behavior. Let’s write a simple test to check if the response status code is 200 for a GET request.

  1. Add Tests: Click the “Tests” tab and write the following JavaScript code:
pm.test("Status code is 200", () => {
  pm.response.to.have.status(200);
});
  1. Send Request: Execute the request, and the test result will be shown in the “Tests” tab.

Utilizing Postman for API Documentation

Postman’s documentation feature is a valuable tool for collaborating with team members and outlining API functionalities.

  1. Create Documentation: Click “Docs” and select “Create a new documentation.”
  2. Add Sections: Organize your documentation into sections (e.g., “Getting Started”, “Endpoints”).
  3. Add Requests and Examples: Import requests from your collections and add code examples to showcase different API functionalities.

Conclusion

Postman is an incredibly powerful tool for API testing and development. By leveraging its features, you can streamline your workflow, manage API data efficiently, and collaborate effectively with your team. Continue exploring Postman’s advanced features like mocks, webhooks, and integrations to enhance your testing process further.

API Testing Blog