disallow additionalQueryParameters in uri

[justinezahiri]

It would be great if you could add a additionalQueryParameters to allow or disallow parameters for a given uriPath

//simlet.yaml

request:
  - method: GET
  - uriPath: '/some-api'
  - additionalQueryParameters: false

Thanks !

[apisim]

Hi @justinezahiri,

Would something like this work?

simlet: match-req-without-queryParms

request:
  - method: GET
  - uriPath: /examples/match-req-without-queryParms
  - where: parameter
    named: QueryParmsCount
    equals: 0

QueryParmsCount:
  is: parameter
  from: uriQueryParameters
  eval: return _.count()

response:
  from: stub
  headers:
    - "content-type: application/text"
  body: "The request had no query string parameters."

We could also use Request Object with some scripting as well.

Happy API Simulating!

[justinezahiri]

Thank you for you response. It could work but in my case what I wanted to do is to allow one or more parameters from a strict list of parameters and disallow any other parameter.

something like :

//simlet.yaml

request:
  - method: GET
  - uriPath: '/some-api'
  - where: parameter
  - named: someParameter  // (can be a list)
  - additionalQueryParameters: false

[apisim]

OK. If it is (quote) "a strict list of [query] parameters", we could make sure the number of query parameters is exactly as expected and no more, along with matching the values of the expected query parameters.

Something like:

//simlet.yaml

request:
  - method: GET
  - uriPath: '/some-api'
  - where: parameter
  - named: someQueryParameter1
    // matching condition...
  - ...
  - where: parameter
  - named: someQueryParameterN
    // matching condition...
  - where: parameter
    named: QueryParmsCount
    equals: <number-of-expected-query-parameters>

QueryParmsCount:
  is: parameter
  from: uriQueryParameters
  eval: return _.count()

Thoughts?

[justinezahiri]

Thank you again for your response, it's quite good also. But my API can have one or more parameters, it's not always the same number. The important thing i want to test here is their names, and to allow only a certain list of parameters names.

[apisim]

We can test if a query parameter with certain name is in the URI using uriQueryParameter. Like in:

request:
  - method: GET
  - uriPath: '/some-api'
  - where: parameter
  - named: SomeQueryParameter1
    exists: true
  - where: parameter
    named: QueryParmsCount
    equals: 1

SomeQueryParameter1:
  is: parameter
  from: uriQueryParameter
  named: "query-string-parameter-name"

QueryParmsCount:
  is: parameter
  from: uriQueryParameters
  eval: return _.count()