Merge pull request #475 from meisterlampe/master

"Hello World"-example should match its spec ( Fixes #476 )

Author: fehguy

README.md

@@ -46,8 +46,8 @@ Code your API's business logic in Node.js.
 ```js
 function hello(req, res) {
     var name = req.swagger.params.name.value || 'stranger';
-    var hello = util.format('Hello, %s', name);
-    res.json(hello);
+    var hello = util.format('Hello, %s!', name);
+    res.json({ "message": hello });
 }
 ```
 
@@ -77,7 +77,7 @@ It just works!
 
 ```bash
 $ curl http://127.0.0.1:10010/hello?name=Scott
-"Hello, Scott!"
+{ "message": "Hello, Scott!" }
 ```
 
 # <a name="installation"></a>Installing the swagger module

docs/controllers.md

@@ -35,9 +35,9 @@ Here is the `hello_world.js` implementation for the quick start example. It retr
     };
 
     function hello(req, res) {
-      var name = req.swagger.params.name.value;
-      var hello = name ? util.format('Hello, %s', name) : 'Hello, stranger!';
-      res.json(hello);
+      var name = req.swagger.params.name.value || 'stranger';
+      var hello = util.format('Hello, %s!', name);
+      res.json({ "message": hello });
     }
 ```
 

docs/quick-start.md

@@ -42,7 +42,7 @@ First, we create a new swagger project and test a simple "hello world" API.
 
     `curl http://127.0.0.1:10010/hello?name=Scott`  
 
-    And, you'll get back the response `Hello, Scott`.
+    And, you'll get back the response `{ "message": "Hello, Scott!" }`.
 
 That's it - You have now created, started and tested your first API project with swagger! 
 

project-skeletons/connect/api/controllers/hello_world.js

@@ -40,5 +40,5 @@ function hello(req, res) {
   var hello = util.format('Hello, %s!', name);
 
   // this sends back a JSON response which is a single string
-  res.json(hello);
+  res.json({ "message": hello });
 }

project-skeletons/connect/test/api/controllers/hello_world.js

@@ -18,7 +18,7 @@ describe('controllers', function() {
           .end(function(err, res) {
             should.not.exist(err);
 
-            res.body.should.eql('Hello, stranger!');
+            res.body.should.eql({ "message": "Hello, stranger!" });
 
             done();
           });
@@ -35,7 +35,7 @@ describe('controllers', function() {
           .end(function(err, res) {
             should.not.exist(err);
 
-            res.body.should.eql('Hello, Scott!');
+            res.body.should.eql({ "message": "Hello, Scott!" });
 
             done();
           });

project-skeletons/sails/api/controllers/hello_world.js

@@ -40,5 +40,5 @@ function hello(req, res) {
   var hello = util.format('Hello, %s!', name);
 
   // this sends back a JSON response which is a single string
-  res.json(hello);
+  res.json({ "message": hello });
 }

project-skeletons/sails/test/api/controllers/hello_world.js

@@ -17,7 +17,7 @@ describe('controllers', function() {
           .end(function(err, res) {
             should.not.exist(err);
 
-            res.body.should.eql('Hello, stranger!');
+            res.body.should.eql({ "message": "Hello, stranger!" });
 
             done();
           });
@@ -34,7 +34,7 @@ describe('controllers', function() {
           .end(function(err, res) {
             should.not.exist(err);
 
-            res.body.should.eql('Hello, Scott!');
+            res.body.should.eql({ "message": "Hello, Scott!" });
 
             done();
           });

test/project-skeletons/common.js

@@ -89,7 +89,7 @@ function testFramework(framework) {
             debug('Result: %s %j', res.text, res.headers);
 
             res.status.should.eql(200);
-            res.body.should.eql('Hello, stranger!');
+            res.body.should.eql({ "message": "Hello, stranger!" });
 
             done();
           });
@@ -104,7 +104,7 @@ function testFramework(framework) {
             debug('Result: %s %j', res.text, res.headers);
 
             res.status.should.eql(200);
-            res.body.should.eql('Hello, Scott!');
+            res.body.should.eql({ "message": "Hello, Scott!" });
 
             done();
           });