Skip to content
Postman API Testing Tips

How To Use Postman Rabbitmq Get Messages

API Testing Blog

Using Postman to Consume Messages from RabbitMQ

Postman is a widely-used tool for API testing, but its capabilities extend beyond simply sending requests. You can also use Postman to interact with messaging queues like RabbitMQ and consume messages. This guide will walk you through the steps of using Postman to retrieve messages from a RabbitMQ queue.

Setting Up Your Environment

Before getting started, ensure you have the following:

  1. RabbitMQ Server: A running instance of a RabbitMQ server. You can either use a local installation or a hosted service like CloudAMQP.
  2. Postman: Install the latest version of Postman from https://www.postman.com/.
  3. Postman’s RabbitMQ Collection: Import the pre-built RabbitMQ collection into Postman. You can find this collection in the Postman public workspace: https://www.postman.com/public/workspaces/postman/documentation/rabbit-mq

Step-by-Step Guide: Consuming Messages

Here’s a step-by-step guide on how to use Postman to consume messages from a RabbitMQ queue:

  1. Configure Environment Variables:
    • Create a new environment in Postman and define the following variables:
      • RABBITMQ_HOST: Your RabbitMQ server hostname or IP address.
      • RABBITMQ_PORT: The port number used by your RabbitMQ server (usually 5672).
      • RABBITMQ_USER: Your RabbitMQ username.
      • RABBITMQ_PASSWORD: Your RabbitMQ password.
      • RABBITMQ_QUEUE: The name of the RabbitMQ queue from which you want to consume messages.
  2. Import the Collection:
    • Import the pre-built RabbitMQ collection into your Postman workspace. This collection contains ready-to-use requests for connecting to RabbitMQ and consuming messages.
  3. Update Request Parameters:
    • Open the Get Messages request in the imported collection.
    • Modify the url parameter to include your RabbitMQ server details: {{RABBITMQ_HOST}}:{{RABBITMQ_PORT}}/api/queues/{{RABBITMQ_QUEUE}}/get.
  4. Add Authorization:
    • Go to the Authorization tab and select “Basic Auth”.
    • Provide your RabbitMQ credentials for the Username and Password fields.
  5. Send the Request:
    • Click the “Send” button to execute the request.
    • Postman will retrieve messages from the specified RabbitMQ queue.
  6. View the Response:
    • The response will contain JSON data, displaying the received messages. Each message will include information like the message body, timestamp, and other relevant details.

Practical Example: Consuming a Message with Example Code

Let’s say you have a queue named “my_queue” in RabbitMQ containing messages with a JSON payload. Here’s how to consume a message:

// Example message payload
{
  "name": "John Doe",
  "age": 30,
  "city": "New York"
}


// Postman environment variables
{
  "RABBITMQ_HOST": "localhost",
  "RABBITMQ_PORT": "5672",
  "RABBITMQ_USER": "guest",
  "RABBITMQ_PASSWORD": "guest",
  "RABBITMQ_QUEUE": "my_queue"
}


// Postman request URL
{{RABBITMQ_HOST}}:{{RABBITMQ_PORT}}/api/queues/{{RABBITMQ_QUEUE}}/get


// Postman Authorization (Basic Auth)
Username: {{RABBITMQ_USER}}
Password: {{RABBITMQ_PASSWORD}}


// Expected Response (JSON)
{
  "messages": [
    {
      "payload": "{ \"name\": \"John Doe\", \"age\": 30, \"city\": \"New York\" }",
      "timestamp": "2023-10-27T14:21:54.862Z",
      "properties": {
        "delivery_tag": "1",
        "redelivered": false,
        "exchange": "",
        "routing_key": "my_queue",
        "content_type": "application/json",
        "content_encoding": null
      }
    }
  ]
}

This example shows how Postman can easily consume messages from a RabbitMQ queue, providing a flexible way to test and validate your message-driven applications.

API Testing Blog