Skip to Content
Jora K

3 mins read


Work with Postman Collections in Java Using Postman4j

Discover how to easily create, manipulate, and serialize Postman collections in Java using the Postman4j library. Generate dynamic collections from HTTP requests, log request chains, and seamlessly integrate with Postman. This guide will enhance your API development workflow with postman on Java 11+.

Intro

Postman provides a very useful SDK to work with Postman collections using JavaScript.

But what if you want to work with Postman collections in Java? There is no official SDK for Java, so I created a library to work with Postman collections in Java 11+. There are JSON schemas for Postman collections. Using them, it is easy to generate Java classes for further work with Postman collections from Java code. With the postman4j-models library, you can use Java classes for Postman collections, which can be used independently to log HTTP request chains in the form of a Postman collection. This functionality allows for easy reuse in the Postman app.

Add the following dependency to your build.gradle file:

implementation group: 'dev.jora.postman4j', name: 'postman4j-models', version: '0.0.3'

How to create Postman collections in Java

Create a new Postman collection Java object using the PostmanCollection.java class and fill it with the data you need:

PostmanCollection postmanCollection = new PostmanCollection();
Information information = new Information();
information.setName(name);
information.setSchema(schemaVersion.getSchemaUrl());
postmanCollection.setInfo(information);

How to read Postman collections in Java

Deserialize an existing Postman collection from a JSON string using ConverterUtils:

PostmanCollection postmanCollection = ConverterUtils.fromJsonString(jsonString);

How to serialize Postman collections in Java

Serialize an existing Postman collection to a pretty-printed JSON string using ConverterUtils:

String jsonString = ConverterUtils.toJsonString(postmanCollection);

How to generate Postman collections dynamically in Java from application HTTP requests

If you are looking for a utility to interactively generate Postman collections from executed requests, check out this postman4j-interceptor utility. It is a Java library that can be used to generate Postman collections interactively from runtime requests, creating dynamic collections and some GET and POST requests in a Java application. Choose a request interceptor based on your library, create these interceptors or filters, and after that, you will be able to generate Postman collections from your application requests. Postman collections generation could be managed using annotations or programmatically.

image

Conclusion

These components work together to facilitate the creation, manipulation, and serialization of Postman collections, enabling efficient logging and reuse of HTTP request chains. All sources are available at github.com/dyadyaJora/postman4j-interceptors, if you find it usefull please star ⭐ this repository and follow me on Github to be notified about new lessons and content.

PROFIT!