Imposter to return a response from examples as a round-robin about imposter HOT 4 CLOSED

Hi @sjabiulla, thanks for your question. Imposter allows you to control the response behaviour via scripting, but this is limited to:

1. the script determining which status code (and thus corresponding example) to return
2. the script returning a literal string response

In other words, the examples themselves are not exposed to the scripts.

With option 2 you do have a way to fully control the response to your caller, but bear in mind the response wouldn't necessarily mirror the content in the spec file - it would be whatever string you configured in the script.

Here's some information about scripting responses: https://github.com/outofcoffee/imposter/blob/master/docs/scripting.md

from imposter.

Thanks for the detailed information.

But, can I script responses with openapi plugin?

I see that, in the example that's mentioned here https://github.com/outofcoffee/imposter/blob/master/docs/scripting.md is using REST plugin.

from imposter.

All current plugins support scripting.

If you were to take the example from above and change the plugin to openapi, and remove the path portion you don't need, it would look like this:

# scripted-openapi-config.yaml
---
plugin: openapi
specFile: petstore.yaml
response:
  scriptFile: example.groovy

This way your example.groovy can control the responses, including specifying:

1. a specific example name to return

respond().withExampleName('example1')

2. the content of a file to return

respond().withFile('some-file.json')

3. a literal string to return

respond().withContent('{ "foo": "bar" }')

from imposter.

Documentation updated: https://github.com/outofcoffee/imposter/blob/master/docs/openapi_plugin.md

from imposter.