example deploying proxy APIs

Author: gojko

Diff for: README.md

@@ -16,6 +16,8 @@
 
 * [Web API](web-api) – a simple REST api, shows how to configure and deploy an API Gateway interface along with the Lambda function
 * [Web Serving HTML](web-serving-html) – shows how to change error and success content types and response codes, and how to perform browser redirects
+* [Generic handlers](web-api-generic-handlers) – shows how to capture dynamic paths and set up handlers for any content type easily
+* [Custom response codes](web-api-custom-status-code) – shows how to change status codes for response
 * [Custom Headers](web-api-custom-headers) – shows how to return custom headers from API responses
 * [Custom CORS origins](web-api-custom-cors) – shows how to control allowed CORS origins/headers
 * [Intercepting requests](intercepting-requests) – an example showing how to prevent or modify requests
@@ -28,6 +30,10 @@
 * [Using AWS Mobile Analytics for server-side events](aws-mobile-analytics) – log events into AWS Mobile Analytics for easy internal telemetry
 * [Custom Authorizers](custom-authorizers) – a simple example of how to set up custom authorizers in API Gateway
 
+## Proxy API
+
+* [Deploying a Proxy API](deploy-proxy-api) – an example of how to create an API Gateway that will proxy all requests directly to a Lambda function
+
 ## Chat-bots
 
 * [Simple Bot](simple-bot) – an example demonstrating how to receive and respond with simple text messages

Diff for: deploy-proxy-api/README.md

@@ -0,0 +1,12 @@
+# Deploying Proxy APIs easily
+
+Since September 2017, API Gateway supports proxying requests to Lambda without having to set up specific handlers, methods or conversion templates. This can be a good alternative to using Claudia API Builder if you need to set up something more generic. Claudia 2.0 can automatically deploy a proxy API for your Lambda function -- just add `--deploy-proxy-api` when creating it.  
+
+To try out this example, use:
+
+1. `npm install` to grab the dependencies
+2. `npm start` to deploy the [api.js](api.js) to Lambda and create a proxy api
+
+The procedure will print out a URL. You can send HTTP requests to it, and any sub-URLs, and get back the full request object as the response.
+
+For more information on this feature, check out [Build an API Gateway API Using Proxy Integration and a Proxy Resource](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy.html ) from AWS documentation.

Diff for: deploy-proxy-api/main.js

@@ -0,0 +1,9 @@
+/*global exports*/
+exports.handler = function (event, context) {
+	'use strict';
+	context.succeed({
+		statusCode: 200,
+		headers: { 'Content-Type': 'application/json' },
+		body: JSON.stringify(event)
+	});
+};

Diff for: deploy-proxy-api/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "deploy-proxy-api",
+  "version": "1.0.0",
+  "description": "a simple example deploying a proxy API with a Lambda function",
+  "main": "index.js",
+  "scripts": {
+    "start": "claudia create --region us-east-1 --deploy-proxy-api --handler main.handler"
+  },
+  "author": "Gojko Adzic <[email protected]>",
+  "license": "MIT",
+  "devDependencies": {
+    "claudia": "^2.0.1"
+  }
+}

Diff for: web-api-custom-status-code/README.md

@@ -0,0 +1,9 @@
+A simple example demonstrating how to use custom response codes in API responses.
+
+1. run `npm install` to grab the dependencies
+2. run `npm start` to set up the lambda project under the default name on AWS 
+3. Check out the API ID in `claudia.json` (the previous step creates the file)
+4. Open https://API_ID.execute-api.us-east-1.amazonaws.com/latest/status-code in a browser (replace API_ID with the API ID from `claudia.json`) and inspect the headers. You should see the status code of 201
+
+Check out [web.js](web.js) to see how the paths are set up. For more information, see the [Claudia Api Builder](https://github.com/claudiajs/claudia-api-builder) documentation.
+

Diff for: web-api-custom-status-code/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "web-api-custom-headers",
+  "description": "An example for returning custom headers from API Gateway responses",
+  "private": true,
+  "files": [
+    "*.js"
+  ],
+  "scripts": {
+    "start": "claudia create --name web-api-custom-headers --region us-east-1 --api-module web",
+    "deploy": "claudia update"
+  },
+  "devDependencies": {
+    "claudia": "^2.0.0"
+  },
+  "dependencies": {
+    "bluebird": "^3.3.4",
+    "claudia-api-builder": "^2.0.0"
+  }
+}

Diff for: web-api-custom-status-code/web.js

@@ -0,0 +1,32 @@
+/*global require, module*/
+var ApiBuilder = require('claudia-api-builder'),
+	api = new ApiBuilder(),
+	Promise = require('bluebird');
+module.exports = api;
+
+// set headers as key-value pairs using the success.headers property */
+api.get('/status-code', function () {
+	'use strict';
+	return 'OK';
+}, {success: 201 });
+
+api.get('/error-code', function () {
+	'use strict';
+	throw 'Abort';
+}, {error: 404});
+
+// or use dynamic codes returning new api.ApiResponse(content, headers)
+api.get('/programmatic-codes', function () {
+	'use strict';
+	return new api.ApiResponse('OK', {'Content-Type': 'text/plain'}, 202);
+});
+
+// dynamic headers also work with promises, just resolve with new api.ApiResponse
+
+api.get('/programmatic-codes-promise', function () {
+	'use strict';
+	return Promise.delay(100).then(function () {
+		return new api.ApiResponse('OK', {'X-Version': '303', 'Content-Type': 'text/plain'}, 400);
+	});
+});
+

Diff for: web-api-generic-handlers/README.md

@@ -0,0 +1,9 @@
+A simple example demonstrating how to create generic handlers with Claudia API Builder. Since September 2016, API Gateway allows you to set up a wildcard path matcher using `{proxy+}`, and set up a single handler for all supported HTTP methods using the `ANY` method. With Claudia API Builder, since version 2.0, you can use both those features directly.
+
+1. run `npm install` to grab the dependencies
+2. run `npm start` to set up the lambda project under the default name on AWS. It will print a URL. 
+3. Open the `URL + '/echo'` in a browser to see the generic response, post to it, or invoke it with some other HTTP method using curl.
+4. Open the `URL + '/dynamic/' + any path` to see how dynamic paths are parsed
+
+Check out [web.js](web.js) to see how the paths are set up. For more information, see the [Claudia Api Builder](https://github.com/claudiajs/claudia-api-builder) documentation.
+

Diff for: web-api-generic-handlers/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "web-api-generic-handlers",
+  "description": "Demo project for generic handlers",
+  "private": true,
+  "files": [
+    "*.js"
+  ],
+  "scripts": {
+    "start": "claudia create --region us-east-1 --api-module web",
+    "deploy": "claudia update"
+  },
+  "devDependencies": {
+    "claudia": "^2.0.0"
+  },
+  "dependencies": {
+    "claudia-api-builder": "^2.0.0"
+  }
+}

Diff for: web-api-generic-handlers/web.js

@@ -0,0 +1,15 @@
+/*global require, module*/
+var ApiBuilder = require('claudia-api-builder'),
+	api = new ApiBuilder();
+module.exports = api;
+
+
+api.any('/echo', function (request) {
+	'use strict';
+	return request;
+});
+
+api.get('/dynamic/{proxy+}', function (request) {
+	'use strict';
+	return 'You called ' + request.pathParams.proxy;
+}, { success: { contentType: 'text/plain'}});