Monday 30 November 2020

Open API catalog import from JDE orchestration to Postman

I'm pretty sure I've blogged about how much I love postman before, it's an amazing tool for kicking off and testing your automation projects.  Being able to see the cURL commands is totally awesome too.

This is a simple blog on how to import ALL your orchestrations (or the ones that you have permission to) into a single postman collection.

There is probably a better way of doing this, but because JDE wants an authenticated call to the listing, I could not use the standard postman import from a URL - as this only seemed to be unauthenticated.


As you can see, there is an option to import from a link, you get a little error down the bottom right saying "Import failed, format not recognized".

So, plan B.

First create a new get request, that looks something like this:

https://f5dv.mye1.com/jderest/v3/open-api-catalog


Once you have done this, ensure that you're authenticating properly to AIS.  I'm using and allowing basic authentication:




Once you send that request, hopefully you get a reply like the one above.

You can use the save button in the middle right of the screen to save this to a local JSON file.



Then in your main postman window, use the import again:



Choose the file that you just saved (the JSON definition)






Choose your file, then you will get this:
Perfect.  Once you hit okay, you'll get a new collection with ALL of your orchestrations.
You will know all of the JSON inputs and all of the standards.  postman also does some nice stuff with variables and the relative paths for the calls.

This is a really neat way of getting all of your orchestration function definitions in one place.  Postman also makes the documentation process nice and easy!


As you can see above, if you create your scenarios and save the payloads, you can provide some amazing documentation for your orchestrations!












1 comment:

Open API said...

Enabling an Open API catalog import from JDE orchestration to Postman is a pivotal stride towards streamlining development workflows. This integration fosters convenience by allowing seamless access to a spectrum of APIs within Postman's user-friendly environment. It promotes efficiency in testing and collaboration, empowering developers to harness the potential of JDE orchestrations effortlessly. The interoperability between these platforms signifies a commitment to enhancing accessibility and simplifying API management. Such innovations pave the way for smoother, more productive development experiences in the tech landscape.