How to Trigger a Mock Response for a digiRunner API in Postman

[jerryhsu0910]

Hey everyone,
I've registered an API in digiRunner and configured a mock response body for it within the digiRunner console. I'm now trying to test this mock response using Postman, but I'm not sure how to make digiRunner return the pre-configured mock body instead of forwarding the request to the actual backend.
Could you please explain the steps or specific headers I need to include in my Postman request to get the mock response back?
Thanks for your help!

[TPIsoftwareOSPO]

Hi @jerryhsu0910 ,
That's a great question, and it's quite straightforward to achieve!
To have digiRunner return the configured mock response body for an API when making a request from Postman (or any other client), you simply need to include a specific header in your request.

Add the following header to your Postman request:

Header Name: dgr_mock_test Header Value: true
By setting the dgr_mock_test header to true, digiRunner will bypass the actual backend service and return the mock response body you've configured for that API.
Give it a try, and let me know if it works for you!