Is there an existing issue for this? <li class="

enhancement request: Add support for validating requests on the API Gateway before proceeding with the integration about localstack HOT 2 CLOSED

robertlcx commented on May 26, 2024

enhancement request: Add support for validating requests on the API Gateway before proceeding with the integration

from localstack.

Comments (2)

localstack-bot commented on May 26, 2024

Welcome to LocalStack! Thanks for reporting your first issue and our team will be working towards fixing the issue for you or reach out for more background information. We recommend joining our Slack Community for real-time help and drop a message to LocalStack Pro Support if you are a Pro user! If you are willing to contribute towards fixing this issue, please have a look at our contributing guidelines and our contributing guide.

from localstack.

bentsku commented on May 26, 2024

Just a note, we currently support request validators for the request Body, validating the JSON Schema.

localstack/localstack/services/apigateway/invocations.py

Lines 95 to 132 in 8ab4114

 def validate_body(self, resource): 

 # if there's no model to validate the body, use the Empty model 

 # https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-apigateway.EmptyModel.html 

 if not (request_models := resource.get("requestModels")): 

 model_name = EMPTY_MODEL 

 else: 

 model_name = request_models.get(APPLICATION_JSON, EMPTY_MODEL) 

 model_resolver = ModelResolver( 

 rest_api_container=self.rest_api_container, 

 model_name=model_name, 

 ) 

 # try to get the resolved model first 

 resolved_schema = model_resolver.get_resolved_model() 

 if not resolved_schema: 

 LOG.exception( 

 "An exception occurred while trying to validate the request: could not find the model" 

 ) 

 return False 

 try: 

 # if the body is empty, replace it with an empty JSON body 

 validate( 

 instance=json.loads(self.context.data or "{}"), 

 schema=resolved_schema, 

 ) 

 return True 

 except ValidationError as e: 

 LOG.warning("failed to validate request body %s", e) 

 return False 

 except json.JSONDecodeError as e: 

 LOG.warning("failed to validate request body, request data is not valid JSON %s", e) 

 return False 

 # TODO implement parameters and headers 

 def validate_parameters_and_headers(self, resource): 

 return True

We are however still missing validating URI, query string, and headers.

from localstack.

Recommend Projects

enhancement request: Add support for validating requests on the API Gateway before proceeding with the integration about localstack HOT 2 CLOSED

Comments (2)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	def validate_body(self, resource):
	# if there's no model to validate the body, use the Empty model
	# https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-apigateway.EmptyModel.html
	if not (request_models := resource.get("requestModels")):
	model_name = EMPTY_MODEL
	else:
	model_name = request_models.get(APPLICATION_JSON, EMPTY_MODEL)

	model_resolver = ModelResolver(
	rest_api_container=self.rest_api_container,
	model_name=model_name,
	)

	# try to get the resolved model first
	resolved_schema = model_resolver.get_resolved_model()
	if not resolved_schema:
	LOG.exception(
	"An exception occurred while trying to validate the request: could not find the model"
	)
	return False

	try:
	# if the body is empty, replace it with an empty JSON body
	validate(
	instance=json.loads(self.context.data or "{}"),
	schema=resolved_schema,
	)
	return True
	except ValidationError as e:
	LOG.warning("failed to validate request body %s", e)
	return False
	except json.JSONDecodeError as e:
	LOG.warning("failed to validate request body, request data is not valid JSON %s", e)
	return False

	# TODO implement parameters and headers
	def validate_parameters_and_headers(self, resource):
	return True