Add example implementation with schema validation.

Author: gersongoulart

.gitignore

@@ -1,3 +1,5 @@
 .idea
 *.iml
-node_modules
+node_modules
+jspm_packages
+api.js

README.md

@@ -34,7 +34,32 @@ gulp.task('schema', function() {
 gulp.task('default', ['schema']);
 ```
 
-Generate client-side API based on schema:
+
+Generate client-side API based on schema for AngularJS:
+
+```js
+var gulp = require('gulp');
+var swagger = require('gulp-swagger');
+
+gulp.task('api', function() {
+  gulp.src('./src/api/index.yaml')
+    .pipe(swagger({
+      filename: 'api.js',
+      type: 'angular' // type can be 'angular', 'node' or 'custom' (default).
+    }))
+    .pipe(gulp.dest('./api'));
+});
+
+gulp.task('default', ['api']);
+
+// Rerun the task when a file changes
+gulp.task('watch', function () {
+  gulp.watch('./src/api/*.yaml', ['api']);
+});
+```
+
+
+Generate client-side API based on schema using custom templates:
 
 ```js
 var gulp = require('gulp');
@@ -63,6 +88,7 @@ gulp.task('watch', function () {
 });
 ```
 
+
 Differently from [Swagger to JS Codegen][swagger-js-codegen], Gulp-Swagger does not require the template field to be on the format `template: { class: "...", method: "...", request: "..." }`. You can pass either of them as you want. Eg. say that your custom `method` and `request` are super simple and you only really need one `class` template, you could only pass `template: { class: "..." }`. For this reason, as a shortcut, `template` can also be a string: `template: "..."`
 
 Gulp-Swagger allows to you pass mustache options along to Codegen. Gulp-Swagger also passes the swagger schema as well as a compilation of all JSON-schemas to mustache options. This is useful if you want to carry schema validation validation on the client-side:
@@ -94,6 +120,7 @@ gulp.task('watch', function () {
 });
 ```
 
+
 So inside your mustache template, you can:
 
 ```
@@ -226,10 +253,16 @@ var schemas = {
 ```
 
 
+Example
+--------------------------
+The provided example implements client-side JSON schema validation using [tv4][tv4] of both Ajax requests and responses.
+
+To play with the example, download this repo. Point your terminal to the example folder and run: `$ npm run setup`. Then open `http://localhost:8888` in your browser, open the dev tools console and play around with the `API` global object.
+
+
 Roadmap
 --------------------------
 - [ ] Test coverage
-- [ ] Implementation Examples
 - [ ] Built-in schema validation
 
 
@@ -256,3 +289,4 @@ Gulp-Swagger is 100% free and open-source, under the [MIT license](LICENSE). Use
 [swagger2spec]: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md
 [swagger-parser]: https://github.com/gersongoulart/gulp-swagger
 [swagger-js-codegen]: https://github.com/wcandillon/swagger-js-codegen
+[tv4]: https://github.com/geraintluff/tv4

example/config.js

@@ -0,0 +1,36 @@
+System.config({
+  "baseURL": "/",
+  "transpiler": "traceur",
+  "paths": {
+    "*": "*.js",
+    "github:*": "jspm_packages/github/*.js",
+    "npm:*": "jspm_packages/npm/*.js"
+  }
+});
+
+System.config({
+  "map": {
+    "bluebird": "npm:bluebird@2.9.25",
+    "nanoajax": "npm:nanoajax@0.2.4",
+    "traceur": "github:jmcriffey/bower-traceur@0.0.88",
+    "traceur-runtime": "github:jmcriffey/bower-traceur-runtime@0.0.88",
+    "tv4": "npm:tv4@1.1.9",
+    "github:jspm/nodelibs-events@0.1.0": {
+      "events-browserify": "npm:events-browserify@0.0.1"
+    },
+    "github:jspm/nodelibs-process@0.1.1": {
+      "process": "npm:process@0.10.1"
+    },
+    "npm:bluebird@2.9.25": {
+      "events": "github:jspm/nodelibs-events@0.1.0",
+      "process": "github:jspm/nodelibs-process@0.1.1"
+    },
+    "npm:events-browserify@0.0.1": {
+      "process": "github:jspm/nodelibs-process@0.1.1"
+    },
+    "npm:tv4@1.1.9": {
+      "fs": "github:jspm/nodelibs-fs@0.1.2"
+    }
+  }
+});
+

example/gulpfile.js

@@ -0,0 +1,31 @@
+var gulp = require('gulp');
+var swagger = require('gulp-swagger');
+var schema = '' +
+	// // Pick one for the demo:
+	// './schemas/json/petstore-expanded.json';
+	// './schemas/json/petstore-minimal.json';
+	// './schemas/json/petstore-simple.json';
+	// './schemas/json/petstore-with-external-docs.json';
+	// './schemas/json/petstore.json';
+	// './schemas/yaml/api-with-examples.yaml';
+	'./schemas/yaml/petstore-expanded.yaml';
+	// './schemas/yaml/petstore.yaml';
+	// './schemas/yaml/uber.yaml';
+
+gulp.task('default', function() {
+	// place code for your default task here
+	return gulp
+		.src(schema)
+		.pipe(
+			swagger({
+				filename: 'api.js',
+				codegen: {
+					template: {
+						class: './templates/api-class.mustache',
+						method: './templates/api-method.mustache'
+					}
+				}
+			})
+		)
+		.pipe(gulp.dest('./'));
+});

example/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head lang="en">
+	<meta charset="UTF-8">
+	<title>Gulp-Swagger example implementation</title>
+	<style>html,h1,p {margin:1rem;font-weight:normal;font-family:sans-serif;}</style>
+</head>
+<body>
+	<h1>Nothing to see here.</h1>
+	<p>Open the dev tools console and play around with the API global object.</p>
+	<script src="jspm_packages/system.js"></script>
+	<script src="config.js"></script>
+	<script>System['import']('index');</script>
+</body>
+</html>

example/index.js

@@ -0,0 +1,21 @@
+'use strict';
+
+import API from 'api';
+
+// Only exposing it for playtime at the console.
+window.API = API;
+
+// Playtime
+console = console || {};
+console.clear();
+Object.keys(API).reduce(function (previous, current) {
+	previous.push('API.' + current + '();');
+	return previous;
+}, [
+	'╔═╗┬ ┬┬  ┌─┐   ╔═╗┬ ┬┌─┐┌─┐┌─┐┌─┐┬─┐',
+	'║ ╦│ ││  ├─┘───╚═╗│││├─┤│ ┬│ ┬├┤ ├┬┘',
+	'╚═╝└─┘┴─┘┴     ╚═╝└┴┘┴ ┴└─┘└─┘└─┘┴└─',
+	'Try invoking these available methods:'
+]).forEach(function logAPIMethods (method) {
+	console.log(method);
+});

example/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "gulp-swagger-example",
+  "version": "1.0.0",
+  "description": "Gulp-Swagger example implementation",
+  "author": "Gerson Goulart <gerson.goulart@gmail.com> (https://github.com/gersongoulart)",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "setup": "npm install -g gulp-cli jspm && npm install && jspm install && gulp && npm start",
+    "start": "node server.js"
+  },
+  "jspm": {
+    "directories": {},
+    "dependencies": {
+      "bluebird": "npm:bluebird@^2.9.25",
+      "nanoajax": "npm:nanoajax@^0.2.4",
+      "tv4": "npm:tv4@^1.1.9"
+    },
+    "devDependencies": {
+      "traceur": "github:jmcriffey/bower-traceur@0.0.88",
+      "traceur-runtime": "github:jmcriffey/bower-traceur-runtime@0.0.88"
+    }
+  },
+  "devDependencies": {
+    "gulp": "^3.8.11",
+    "gulp-swagger": "^0.0.3"
+  }
+}