Feature request: Select from multiple examples by name

[mkq]

As per README.md,

If multiple examples for the response object are specified, the first one will be used as a resulting sever response.

I would like to select the example by name, on a per request basis. For example, I might have examples named "myResourceFlat" and "myResourceWithSubresources" in the OpenAPI spec, and want to return "myResourceWithSubresources" if query parameter "expand=subresources" is present, else "myResourceFlat".

Could you please add support for this? Maybe something like

createMockMiddleware(
    ...,
    exampleSelector: (req, defaultExampleSelector) => {
        // const defaultExample = defaultExampleSelector(req) //? if needed
        return req.query?.expand === 'subresources' ? 'myResourceWithSubresources' : 'myResourceFlat'
    }
}

(Maybe I'm missing something which can already be done with a jsfCallback, as I'm new to openapi-mock-express-middleware and know even less about json-schema-faker.)

Thanks!

[aleksandryackovlev]

Sorry for the late reply.

For now I can't come up with a fast solution for this use case. It's because the config for json-schema-faker, where we handle usage of examples, is created not at the time of request. Hence, there is no access to the req object. See https://github.com/aleksandryackovlev/openapi-mock-express-middleware/blob/master/src/utils/generator.ts#L14

[mkq]

Thanks for the reply. Looking forward to the not-so-fast solution then, maybe… :-)

Or does it make more sense to open a json-schema-faker feature request?

[aleksandryackovlev]

It doesn't have anything to do with json-schema-faker. This issue is about how openapi-mock-express-middleware is made.
I didn't think about such a use case at the time of its creation.

Anyway, the ability to select a response for a particular request could definitely be useful.

I'm gonna think how to implement it.

[aleksandryackovlev]

The feature has been implemented partially. Now it's possible to add custom logic for the generation of responses from the examples attributes. See https://github.com/aleksandryackovlev/openapi-mock-express-middleware#responses-generated-from-examples.

Yet the request object is still not available for the configure method. I've added this feature to the roadmap for the next major version.