add swagger.json and swagger-ui documentation

Author: danivek

README.md

@@ -7,10 +7,10 @@ Feel free to contribute to build a fully working [JSON API](http://jsonapi.org/)
 
 ## Installation
 
-1. Clone repo
+1. `git clone https://github.com/danivek/json-api-express.git`
 2. `npm install`
 3. `npm start`
-4. Browse http://localhost:8080
+4. Browse http://localhost:8080/docs
 
 ## Usage
 
@@ -26,6 +26,8 @@ Try some endpoints :
  * http://localhost:8080/tags
  * ...
 
+Or explore api endpoints with swagger-ui at : http://localhost:8080/docs
+
 ## Features
  * [Sparse Fieldsets](http://jsonapi.org/format/#fetching-sparse-fieldsets)
  * [Sorting](http://jsonapi.org/format/#fetching-sorting)

package.json

@@ -15,6 +15,7 @@
     "json-api-serializer": "^0.3.0",
     "lodash": "^4.6.1",
     "mongoose": "^4.4.6",
-    "qs": "^6.1.0"
+    "qs": "^6.1.0",
+    "swagger-ui": "^2.1.4"
   }
 }

src/docs/docs.routes.js

@@ -0,0 +1,16 @@
+var express = require('express');
+
+var router = express.Router();
+
+router.use('/docs', function(req, res, next) {
+  if (!req.query.url) {
+    return res.redirect(301, '?url=/docs/swagger.json');
+  }
+  next();
+});
+router.use('/docs', express.static(__dirname + '/../../node_modules/swagger-ui/dist'));
+router.get('/docs/swagger.json', function(req, res, next) {
+  res.json(require('./swagger.json'));
+})
+
+module.exports = router;