ctimmerm / axios-mock-adapter

Axios adapter that allows to easily mock requests
MIT License
3.44k stars 241 forks source link

adds support for url params from url regexp capture groups #301

Open ifrim opened 3 years ago

ifrim commented 3 years ago

This PR adds support for url params taken from named capture groups of regex urls.

Below is an example of mocking a request to /api/foo/1/bar/2 where we need some data from the url. Before:

mock.onGet(/\/api\/foo\/[^/]+\/bar\/[^?/]+$/).reply(function (config) {
  let { fooId, barId } = config.url.match(/\/api\/foo\/(?<fooId>[^/]+)\/bar\/(?<barId>[^?/]+)$/).groups;
  console.log(fooId, barId); // 1, 2
  return [200];
});

After:

mock.onGet(/\/api\/foo\/(?<fooId>[^/]+)\/bar\/(?<barId>[^?/]+)$/).reply(function (config) {
  let { fooId, barId } = config.urlParams;
  console.log(fooId, barId); // 1, 2
  return [200];
});

This allows us to define the data we want from the url and to have it available in the reply function without having to duplicate the same (or similar) regex to extract the data.

Notes

If there is anything that needs to be changed in this PR I am happy to do it.

This can be an alternative and an easy win for https://github.com/ctimmerm/axios-mock-adapter/pull/205.

kennethbruskiewicz commented 2 years ago

I would appreciate this feature as well.