Add apidoc

.gitignore

@@ -30,5 +30,5 @@ benchmarks/graphs
 .vscode
 
 dist/
-
+public/apidoc/
 todo

README.md

@@ -11,8 +11,11 @@ Start mongodb
 Run server
 * ```$ yarn watch```
 
+Generate ApiDoc
+* ```$ yarn docs```  
+Open it on `/apidoc/`
 
-[**Aditional docs**](https://gitlab.com/edudepetris/eldolar/wikis/Tutorials-&-Sources)
 
+[**Aditional docs**](https://gitlab.com/edudepetris/eldolar/wikis/Tutorials-&-Sources)
 
 [**Deployed on Heroku**](https://glacial-dusk-89024.herokuapp.com/api/v1/exchanges/now)

apidoc.json

@@ -0,0 +1,7 @@
+{
+  "name": "El Dolar",
+  "version": "0.1.0",
+  "description": "",
+  "title": "",
+  "url" : "https://api.github.com/v1"
+}

package.json

@@ -7,6 +7,7 @@
   "dependencies": {
     "@types/cheerio": "^0.22.9",
     "@types/express": "^4.16.0",
+    "apidoc": "^0.17.7",
     "axios": "^0.18.0",
     "cheerio": "^1.0.0-rc.2",
     "concurrently": "^4.0.1",
@@ -19,7 +20,9 @@
     "test": "mocha -r ts-node/register test/**/*.ts",
     "watch-ts": "tsc -w",
     "watch-node": "nodemon dist/app.js",
-    "watch": "concurrently -k -p \"[{name}]\" -n \"TypeScript, Node\" -c \"yello.bold, cyan.bold\" \"yarn run watch-ts\" \"yarn run watch-node\""
+    "watch": "concurrently -k -p \"[{name}]\" -n \"TypeScript, Node\" -c \"yello.bold, cyan.bold\" \"yarn run watch-ts\" \"yarn run watch-node\"",
+    "docs": "apidoc -i src/ -o public/apidoc/"
+
   },
   "devDependencies": {
     "@types/chai": "^4.1.5",

src/app.ts

@@ -22,6 +22,9 @@ app.set("port", process.env.PORT || 3000);
 // routers
 app.use('/api/v1/exchanges', ExchangeRouter)
 
+// apidoc
+app.use(express.static('public'));
+
 // start
 app.listen(app.get("port"), () => {
   console.log("App is running on localhost:%d", app.get("port"));

src/routers/exchangeRouter.ts

@@ -4,7 +4,25 @@ import FetchNewExchangeService from '../services/fetchNewExchangeService';
 
 const router: Router = Router();
 
-// - GET /exchanges/now # returns all exchanges
+/**
+ * @api {get} /exchanges/new Request Current exchange information
+ * @apiName GetExchange
+ * @apiGroup Exchange
+ *
+ * @apiSuccessExample {json} Success-Response:
+ *     HTTP/1.1 200 OK
+ * {
+ *   "banks":[
+ *     { 
+ *       "buy":{"$numberDecimal":"36.7"},
+ *       "sell":{"$numberDecimal":"38.5"},"
+ *       "name":"Nación"
+ *     },
+ *     ...
+ *   ]
+ * }
+ */
+
 function exchange(req: Request, res: Response) : void {
   Exchange.findOne({}).sort('-createdAt')
     .then((exchange : IExchange) => {