3. Security and Validation

queryParamExtractor

Extracts an API key from a URL query parameter. By default, the parameter name is api-key. If the parameter is present in the request URI, its value is returned as the API key. Parameter name matching is case-insensitive.

Example usage inside <apiKey>: 

<apiKey>
   <queryParamExtractor /> 

   
   <queryParamExtractor name="api_key"/>
 </apiKey>

Can be used in:

apiKey

Attributes

NameRequiredDefaultDescriptionExamples
name false api-key
 The query parameter name to check for an API key.
api_key