Miserlou/Zappa

API Gateway caching and query parameters

Open

#1081 opened on Sep 4, 2017

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (11,903 stars) (1,286 forks)batch import
hacktoberfesthelp wanted

Description

I'm currently trying to configure the caching on API Gateway side to reduce the load of my database. The endpoint I'm trying to configure is using a query parameter to pass-in the term the user typed into the search bar. I already enabled caching on APG side but unfortunately had to find out that by default it's ignoring the query parameters when building the cache key. While I don't really get why that is sensible default behavior to AWS I was wondering what would be the best way to configure it properly using Zappa. I already found one example for serverless (http://theburningmonk.com/2016/04/serverless-enable-caching-on-query-string-parameters-in-api-gateway/) but am wondering what I need to put for CacheKeyParameters into my CF template?

Any ideas?

Contributor guide

Tech stack
pythonawsrest api
Domain
backendcloudapiperformance
Issue type
performance
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
PythonAWSZappaCloudFormation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate Zappa's CloudFormation template generation to add CacheKeyParameters for query strings. Refer to the linked article about serverless framework as a reference. Check Zappa's documentation and source code in `zappa/zappa.py` for cache settings. Consider opening a discussion to clarify desired behavior.