Skip to content
Postman API Testing Tips

How Can I Use My Rest Api In Postman

API Testing Blog

Getting Started with Postman and Your REST API

Postman is a powerful tool for working with APIs. It helps you send requests, view responses, and manage your API workflow. This guide will walk you through the fundamentals of using Postman to test your REST API.

Understanding the Basics

Before diving into Postman, let’s revise the core components of a REST API:

  • Endpoints: These are specific URLs that define different resources your API offers. For example, /users might retrieve a list of users, and /users/123 might fetch details for a user with ID 123.
  • Methods: HTTP methods like GET, POST, PUT, DELETE, and PATCH define the action you want to perform on the resource.
  • Headers: These provide additional information about the request, like the content type or authorization details.
  • Body: This section carries the data you send with the request (e.g., for creating or updating a resource).

Setting Up Your First Request

  1. Install Postman: Download and install Postman from https://www.postman.com/.

  2. Create a new request:

    • Click the “New” button in the top-left corner.
    • Choose “Request.”

  3. Define the request:

    • Method: Select the appropriate HTTP method (GET, POST, PUT, DELETE, PATCH) based on your API’s actions.
    • URL: Enter the complete endpoint URL of your API.
    • Headers: Add any necessary headers, such as “Content-Type” if you’re sending JSON data (e.g., application/json).

Sending Your First Request

  1. Example GET Request: Let’s assume you have a simple endpoint for fetching a list of users:

    • URL: https://api.example.com/users

    Click the “Send” button to execute the request.

  2. Viewing the Response: Postman will display the response from your API, including:

    • Status Code: Indicates the success or failure of the request (e.g., 200 for success).
    • Headers: Provides information about the response.
    • Body: Contains the actual data returned by the API.

Working with Different Methods

  • POST: Used to create new resources.

    • Example: Create a new user
      • URL: https://api.example.com/users
      • Method: POST
      • Body: (JSON format)
      {
        "name": "John Doe",
        "email": "john.doe@example.com"
      }

  • PUT: Used to update existing resources.

    • Example: Update user with ID 123
      • URL: https://api.example.com/users/123
      • Method: PUT
      • Body:
      {
        "email": "updated@example.com"
      }

  • DELETE: Used to delete resources.

    • Example: Delete user with ID 123
      • URL: https://api.example.com/users/123
      • Method: DELETE

Sending Authenticated Requests

Many APIs require authentication. You can configure authentication in Postman:

  1. Basic Auth:

    • Go to the “Authorization” tab.
    • Select “Basic Auth.”
    • Enter your username and password.

  2. Bearer Token:

    • Go to the “Authorization” tab.
    • Select “Bearer Token.”
    • Paste your access token in the “Token” field.

Using Environment Variables

Postman enables you to store dynamic values (like API keys or URLs) in environment variables:

  1. Create an environment: Go to “Environments” and click “Add.”
  2. Add variables: Enter the variable name (e.g., “API_KEY”) and its value.
  3. Use in requests:
    • In the request URL or headers, use {{API_KEY}} to dynamically access the variable value.

Automate Your Testing with Collections

Postman collections group multiple requests together for organized testing:

  1. Create a Collection: Click the “Create” button and select “Collection.”
  2. Add Requests: Drag and drop existing requests or create new ones.
  3. Organize with Folders: Group related requests within folders for better structure.
  4. Run Collections: Execute all the requests in the collection sequentially.

Running Tests and Assertions

Postman allows you to write test scripts to automatically validate API responses:

  1. Test Tab: Open the “Tests” tab after sending a request.
  2. Add Tests:
    • pm.test: Write code to check specific conditions in the response.
    • pm.expect: Use expectations to assert values (e.g., pm.expect(response.code).to.eql(200)).

Example Tests:

pm.test("Status code is 200", function () {
  pm.expect(response.code).to.eql(200);
});


pm.test("Response has a valid JSON body", function () {
  pm.expect(response.json()).to.be.an('object');
});

Conclusion

Using Postman effectively for REST API testing allows you to streamline your testing workflow, manage requests, and easily validate your API’s behavior. The features mentioned above provide you with a strong foundation to begin exploring Postman’s extensive capabilities and enhance your API testing process.

API Testing Blog