initial custom headers example, using development versions of api-builder and claudia

Author: gojko

web-api-custom-headers/README.md

@@ -0,0 +1,9 @@
+A simple example demonstrating how to use custom headers 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/hard-coded-headers in a browser (replace API_ID with the API ID from `claudia.json`) and inspect the headers. You should see an `X-Version` header with the value `101`, and `Content-Type` of `text/plain`
+
+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.
+

web-api-custom-headers/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": "github:claudiajs/claudia"
+  },
+  "dependencies": {
+    "bluebird": "^3.3.4",
+    "claudia-api-builder": "github:claudiajs/claudia-api-builder"
+  }
+}

web-api-custom-headers/web.js

@@ -0,0 +1,34 @@
+/*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('/hard-coded-headers', function () {
+	'use strict';
+	return {a: 'b'};
+}, {success: {headers: {'X-Version': '101', 'Content-Type': 'text/plain'}}});
+
+// or use dynamic headers by enumerating them as an array, then returning new api.ApiResponse(content, headers)
+api.get('/programmatic-headers', function () {
+	'use strict';
+	return new api.ApiResponse('OK', {'X-Version': '202', 'Content-Type': 'text/plain'});
+}, {success: {headers: ['X-Version', 'Content-Type']}});
+
+// dynamic headers also work with promises, just resolve with new api.ApiResponse
+
+api.get('/programmatic-headers-promise', function () {
+	'use strict';
+	return Promise.delay(100).then(function () {
+		return new api.ApiResponse('OK', {'X-Version': '303', 'Content-Type': 'text/plain'});
+	});
+}, {success: {headers: ['X-Version', 'Content-Type']}});
+
+// error handlers can only use hard-coded header values, dynamic headers are not supported
+
+api.get('/error-headers', function () {
+	'use strict';
+	throw 'Abort';
+}, {error: {headers: {'X-Version': '404'}}});
+