Skip to content

Home

Jump to bottom
David Gofman edited this page Jun 11, 2026 · 8 revisions

JPostman Wiki Home

Welcome to the JPostman Wiki.

JPostman is a lightweight Java library for reusing exported Postman collections and environments in Java API tests. It helps you move API testing workflows from Postman into Java-based test automation projects while keeping your existing Postman collections reusable.

Documentation

YouTube Channel

Watch JPostman tutorials on YouTube:

https://www.youtube.com/@JPostmanAPI

This Wiki will be updated with new tutorial pages as future videos are published.

Tutorial Videos

Part Topic Wiki Page
Part 1 JPostman setup and Java Maven API testing project creation JPostman Tutorial Part 1: JPostman Setup and create a Java Maven API Testing Project
Part 2 Execute REST API requests with RestAssured JPostman Tutorial Part 2: Execute REST API Requests with RestAssured
Part 3 Access token and chained requests JPostman Tutorial Part 3: Access Token and Chained Requests
Part 4 Secure API logs with jpostman-secure JPostman Tutorial Part 4: Secure API Logs with jpostman-secure

Tutorial Roadmap

The current tutorials cover setup, REST API execution, chained requests, and secure logging:

  1. Create a Java Maven API testing project.
  2. Export Postman collection and environment JSON files.
  3. Add JPostman Maven dependencies.
  4. Execute REST API requests from Java.
  5. Use RestAssured as the execution adapter.
  6. Resolve Postman environment variables.
  7. Validate API responses with assertions.
  8. Chain requests using an access token.
  9. Protect request and response logs with jpostman-secure.
  10. Move reusable secure rules into INI policy profiles.

Future tutorials will be added here as new videos are released.

Current Tutorial Series

Part 1: Setup JPostman in a Java Maven Project

The first tutorial explains how to create a Java Maven project and configure it with JPostman.

Topics include:

  • Creating a Maven project.
  • Exporting a Postman collection.
  • Exporting a Postman environment.
  • Adding jpostman-core.
  • Adding TestNG.
  • Loading collection and environment files from src/test/resources.

Wiki page:

https://github.com/JPostman/jpostman/wiki/JPostman-Tutorial-Part-1:-JPostman-Setup-and-create-a-Java-Maven-API-Testing-Project

Part 2: Execute REST API Requests with RestAssured

The second tutorial explains how to execute a REST API request from Java using the JPostman RestAssured adapter.

Topics include:

  • Adding jpostman-restassured.
  • Adding Logback for console logging.
  • Printing the loaded Postman collection.
  • Selecting a request from the collection.
  • Resolving environment placeholders.
  • Executing the request with RestAssuredExecutor.

Wiki page:

https://github.com/JPostman/jpostman/wiki/JPostman-Tutorial-Part-2:-Execute-REST-API-Requests-with-RestAssured

Part 3: Access Token and Chained Requests

The third tutorial explains how to work with access tokens and chained requests.

Topics include:

  • Understanding immutable Request objects.
  • Building resolved requests.
  • Comparing unresolved and resolved requests.
  • Adding status code assertions.
  • Extracting an accessToken from a login response.
  • Passing the token to another request.
  • Creating a chained API test flow.

Wiki page:

https://github.com/JPostman/jpostman/wiki/JPostman-Tutorial-Part-3:-Access-Token-and-Chained-Requests

Part 4: Secure API Logs with jpostman-secure

The fourth tutorial explains how to protect request and response logs with the jpostman-secure module.

Topics include:

  • Adding jpostman-secure.
  • Creating a SecureContext.
  • Wrapping requests with SecureRequest.
  • Wrapping responses with SecureResponse.
  • Using secret(env) and unsecret(...).
  • Masking sensitive fields with redact(...).
  • Protecting headers with headers(...).
  • Reducing response headers with headersFilter(...).
  • Loading secure INI policy files.
  • Applying policy profiles with loadRules(...).
  • Filtering response output with filter(...).

Wiki page:

https://github.com/JPostman/jpostman/wiki/JPostman-Tutorial-Part-4:-Secure-API-Logs-with-jpostman-secure

Maven Modules

JPostman provides a core library, optional executor adapters, and secure logging support.

Module Description
jpostman-core Main library for loading and resolving Postman collections and environments
jpostman-restassured RestAssured executor adapter
jpostman-httpclient Java HttpClient executor adapter
jpostman-playwright Playwright executor adapter
jpostman-unirest Unirest executor adapter
jpostman-secure Secure request and response logging, redaction rules, and policy profiles

Useful Links

Future Updates

This Home page is the starting point for the JPostman tutorial series.

As new videos are created, add them to the Tutorial Videos table and include a short summary under the Current Tutorial Series section.

JPostman Core API

JPostman Annotation API

Clone this wiki locally