Postman is a popular tool for working with APIs. We have published a collection for testing and documentation using Postman.
Postman provides extensive features for performing integration testing with our API. It allows for repeatable, reliable tests that can be automated and used in a variety of environments and includes useful tools for persisting data. See the Postman Learning Centre.
Download the latest version of Postman from https://www.getpostman.com/
To import the collection, first copy this link:
Open Postman and press the Import button in the top left:
Then press "Import From Link" in the popup that appears, then follow the instructions in the box:
Finally, paste the saved link into this window and press "Import"
The collection is available from the sidebar under "Collections":
The Collection comes with various example requests, that have been set up with Collection specific variables - "scheme", "host", and "port" as shown in the URL for the Pipelines Info shown below.
These three variables have the respective default values of
If you need to change these, then click the "..." button in the sidebar next to the Collection name, then "Edit". Note that the Variables tab is only available for the Collection not the individual requests.
From "Variables" you can then edit as required - e.g. if the REST service is running over a different port than 8080:
Some requests also have example responses (available under the "Examples" dropdown in the top-right) - showing you the sort of HTTP response you can expect from the service: