Q: Is there an option to create Postman requests per response?

[thim81]

In OpenAPI you can define multiple requests & responses.

OpenAPI
200 > success
404 > not found

Is there a way to generate multiple requests from OpenAPI to Postman, where 1 request will have use the examples for the 200 request/response and 1 request will have use the examples for the 404?

[pcgamer1]

@thim81 I don't think there is any such feature, but I'm fairly new so might be wrong. Do you have any idea about how this might be implemented? What would you expect the input to be in case a separate request has to be created for each response status code? Thanks.

[thim81]

@pcgamer1

In the OpenAPI you can define multiple responses (200, 404, ...)

I was wondering, what options there would be to generate request per response, which would make it easier to create postman tests per response type per request.

Example based on the screenshot:
in Postman you would have:

• /lead/leads - 200 request
• /lead/leads - 400 request
• /lead/leads - 401 request

...

This would off course not be "default" behaviour, but it might be CLI parameters to generate requests per response.

[pcgamer1]

@thim81 Thanks for the explanation, I had understood the requirement. I wanted to know how would you want it to be implemented, there might be multiple paths you want this to be done for, so passing an array of the paths and the methods for each one for which you want to have seperate requests for each response will be a good CLI parameter right? What do you think? Thanks.

[thim81]

That is a good question, how to define for which. What I did in my PR #225 about contract testing was using the operationId from OpenAPI but the feedback was that operationId is not a property that is always used. The feedback suggested using a combination of the path and the operation method (get,post,...). You want to have some control over when it would make sense the have multiple requests, so path and method seems a great direction.

What do you think?

[pcgamer1]

@thim81 Yeah, that sound good. Thanks for the help. If you wanted to go ahead with working on this please do and let me know. Otherwise I'll try to have a look and figure out how to implement this feature.

[pcgamer1]

@thim81 I'm working on this, getting a bit complicated as it collides with my multiple examples changes, should be done in sometime.

[thim81]

@pcgamer1 I had a look and it looks very promising.

What would be the behaviour if there are no separate examples specified? You would fallback at the normal Postman generation, with 1 request.

[pcgamer1]

@thim81 Thanks.

Separate requests are generated for each response code. Multiple examples will be generated for each response code when integrated with my multiple examples PR - #350 .

[thim81]

@pcgamer1

It looks great. I'm going to give it a spin in the coming weeks, because it would make testing "unhappy" responses based on the examples much easier.

Side-question:

• Would it possible to define multiple examples for headers/query parameters and link them to the multiple example responses?

[thim81]

@pcgamer1 I've cancelled the feature request, since the use case would be very specific.
I looked the code and it works as expected, so great job for that.

I think that an additional option to toggle it on or off, would be required to move forward with the PR.

The PR will have an impact on the future maintenance, but the code itself is very readable and well organised.