serverless-api-gateway-caching - npm Package Compare versions

Comparing version 1.9.0-rc5 to 1.9.0

.vscode/launch.json

@@ -0,0 +0,0 @@ {

package.json

 {
   "name": "serverless-api-gateway-caching",
-  "version": "1.9.0-rc5",
+  "version": "1.9.0",
   "description": "A plugin for the serverless framework which helps with configuring caching for API Gateway endpoints.",
@@ -5,0 +5,0 @@ "main": "src/apiGatewayCachingPlugin.js",

README.md

@@ -56,2 +56,6 @@ # serverless-api-gateway-caching
 
+## Only supports REST API
+
+This plugin only supports REST API, because HTTP API does not support API Gateway Caching at the time of this writing. See [docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.html).
+
 ## Time-to-live, encryption, cache invalidation settings
@@ -151,4 +155,4 @@
 - `GET /cats/4` will create a cache entry for `pawId=4` and `catName` as `undefined`.
-- `GET /cats/34?catName=Toby` will create a cache entry for `pawId=34` and `catName=Toby`.
-- `GET /cats/72?catName=Dixon&furColour=white` will create a cache entry for `pawId=72` and `catName=Dixon`, but will ignore the `furColour` query string parameter. That means that a subsequent request to `GET /cats/72?catName=Dixon&furColour=black` will return the cached response for `pawId=72` and `catName=Dixon`.
+- `GET /cats/34?catName=Dixon` will create a cache entry for `pawId=34` and `catName=Dixon`.
+- `GET /cats/72?catName=Tsunami&furColour=white` will create a cache entry for `pawId=72` and `catName=Tsunami`, but will ignore the `furColour` query string parameter. That means that a subsequent request to `GET /cats/72?catName=Tsunami&furColour=black` will return the cached response for `pawId=72` and `catName=Tsunami`.
 
@@ -392,2 +396,49 @@ ### Cache key parameters from the path, query string and header
 
+## Configuring caching when the endpoint bypasses lambda and talks to a service like DynamoDb
+
+This example uses the `serverless-apigateway-service-proxy` plugin which creates the path `/dynamodb?id=cat_id`.
+Caching can be configured using the `additionalEndpoints` feature. The method and path must match the ones defined as a service proxy. It also supports cache key parameters.
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
+  - serverless-apigateway-service-proxy
+
+custom:
+  apiGatewayCaching:
+    enabled: true
+    additionalEndpoints:
+      - method: GET
+        path: /dynamodb
+        caching:
+          enabled: true
+          ttlInSeconds: 120
+          cacheKeyParameters:
+            - name: request.querystring.id
+
+  apiGatewayServiceProxies:
+    - dynamodb:
+        path: /dynamodb
+        method: get
+        tableName: { Ref: 'MyDynamoCatsTable' }
+        hashKey:
+          queryStringParam: id # use query string parameter
+          attributeType: S
+        action: GetItem
+        cors: true
+
+resources:
+  Resources:
+    MyDynamoCatsTable:
+      Type: AWS::DynamoDB::Table
+      Properties:
+        TableName: my-dynamo-cats
+        AttributeDefinitions:
+          - AttributeName: id
+            AttributeType: S
+        KeySchema:
+          - AttributeName: id
+            KeyType: HASH
+```
+
 ## More Examples
@@ -394,0 +445,0 @@

src/apiGatewayCachingPlugin.js

 'use strict';
 
 const ApiGatewayCachingSettings = require('./ApiGatewayCachingSettings');
-const pathParametersCache = require('./pathParametersCache');
+const cacheKeyParameters = require('./cacheKeyParameters');
 const updateStageCacheSettings = require('./stageCache');
@@ -40,3 +40,3 @@ const { restApiExists, outputRestApiIdTo } = require('./restApiId');
 
-    return pathParametersCache.addPathParametersCacheConfig(this.settings, this.serverless);
+    return cacheKeyParameters.addCacheKeyParametersConfig(this.settings, this.serverless);
   }
@@ -43,0 +43,0 @@

src/ApiGatewayCachingSettings.js

@@ -0,0 +0,0 @@ const get = require('lodash.get');

src/restApiId.js

@@ -0,0 +0,0 @@ 'use strict';

src/stageCache.js

@@ -0,0 +0,0 @@ const isEmpty = require('lodash.isempty');

src/UnauthorizedCacheControlHeaderStrategy.js

@@ -0,0 +0,0 @@ module.exports = {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44747

increased by0.53%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

501

increased by11.33%

No dependency changes