Merge pull request #365 from ageddesi/dev

v0.20.0 candidate

.all-contributorsrc

@@ -473,6 +473,16 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "shodown96",
+      "name": "Elijah Soladoye",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41167893?v=4",
+      "profile": "http://elijahsoladoye.vercel.app",
+      "contributions": [
+        "code",
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -1,6 +1,6 @@
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-51-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-52-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <p align="center" style="margin-bottom: 20px">
@@ -181,6 +181,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="http://suppergerrie2.com"><img src="https://avatars.githubusercontent.com/u/15769860?v=4?s=100" width="100px;" alt="Suppergerrie2"/><br /><sub><b>Suppergerrie2</b></sub></a><br /><a href="https://github.com/ageddesi/Mocked-API/commits?author=suppergerrie2" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/dipushrestha"><img src="https://avatars.githubusercontent.com/u/36785868?v=4?s=100" width="100px;" alt="Dipendra Shrestha"/><br /><sub><b>Dipendra Shrestha</b></sub></a><br /><a href="https://github.com/ageddesi/Mocked-API/commits?author=dipushrestha" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://elijahsoladoye.vercel.app"><img src="https://avatars.githubusercontent.com/u/41167893?v=4?s=100" width="100px;" alt="Elijah Soladoye"/><br /><sub><b>Elijah Soladoye</b></sub></a><br /><a href="https://github.com/ageddesi/Mocked-API/commits?author=shodown96" title="Code">💻</a> <a href="https://github.com/ageddesi/Mocked-API/commits?author=shodown96" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

api/.env.example

@@ -6,4 +6,4 @@ SENTRY_DSN=https://23423423.ingest.sentry.io/234234
 ENABLE_SENTRY=false
 ENABLE_RATE_LIMIT=false
 ENABLE_MORGAN_LOGGING=false
-ENABLE_SWAGGER=false
+ENABLE_SWAGGER=true

api/app.ts

@@ -49,6 +49,12 @@ app.get('/full-status', (req, res) => {
 
 app.use(cors()); // enabling CORS for all requests;
 
-if (process.env.ENABLE_SWAGGER === 'true') initSwagger(app); // setup Swagger;
+if (process.env.ENABLE_SWAGGER === 'true'){
+    initSwagger(app); // setup Swagger;
+} else {
+    app.get('/', (req, res) => {
+        res.status(200).send('Welcome to the Mocked API')
+    })
+}
 
 export default app;

api/src/modules/ecommerce/api/ecommerce-routes.ts

@@ -80,15 +80,6 @@ import { getEcommerceCart } from '../utils/get-ecommerce-cart';
  *            $ref: '#/definitions/MockEcommerceProduct'
  */
 
-/**
- * @openapi
- * definitions:
- *   MockEcommerceCartList:
- *     type: array
- *     items:
- *       $ref: '#/definitions/MockEcommerceCart'
- */
-
 module.exports = function (app: core.Express) {
     /**
      * @openapi
@@ -118,12 +109,12 @@ module.exports = function (app: core.Express) {
      *     parameters:
      *     - in: path
      *       name: qty
-     *       description: The number of carts you want
+     *       description: The number of products you want in your cart
      *     responses:
      *       '200':
      *         description: OK
      *         schema:
-     *           $ref: '#/definitions/MockEcommerceCartList'
+     *           $ref: '#/definitions/MockEcommerceCart'
      */
     app.get('/ecommerce/cart/:qty', (req: Request, res: Response) => {
         const ecommerceCart = getEcommerceCart(req);

api/src/modules/facts/api/facts-routes.ts

@@ -0,0 +1,52 @@
+import { Request, Response } from 'express';
+import * as core from 'express-serve-static-core';
+import { getQtyFromRequest } from '../../../utils/route-utils';
+import facts from '../data/facts';
+
+module.exports = function (app: core.Express) {
+    /**
+     * @openapi
+     * '/facts/random':
+     *   get:
+     *     tags:
+     *     - Facts
+     *     summary: Get a random fact from the database
+     *     responses:
+     *       '200':
+     *         description: OK
+     *         schema:
+     *           type: object
+     *           example: { fact: '', category: ''}
+     */
+    app.get('/facts/random', (req: Request, res: Response) => {
+        const fact = facts[Math.floor(Math.random() * facts.length)];
+        res.json(fact);
+    });
+
+    /**
+     * @openapi
+     * '/facts/{qty}':
+     *   get:
+     *     tags:
+     *     - Facts
+     *     summary: Get a list of all facts from the database
+     *     parameters:
+     *     - in: path
+     *       name: qty
+     *       description: The amount of results you would like returned
+     *       default: 10
+     *       type: number
+     *     responses:
+     *       '200':
+     *         description: OK
+     *         schema:
+     *           type: array
+     *           items:
+     *             type: object
+     *             example: { fact: '', category: ''}
+     */
+    app.get('/facts/:qty', (req: Request, res: Response) => {
+        const qty = getQtyFromRequest(req);
+        res.json(qty >= facts.length ? facts : facts.slice(0, qty));
+    });
+};