annotations

backend/controllers/api/RulesController.js

@@ -0,0 +1,60 @@
+import express from 'express';
+
+/**
+ * RulesController. API for the game rules manager
+ */
+class RulesController{
+    
+    name = 'rulesApi'
+    route = '/api/rule'
+
+    /**
+     * Initializes the RulesController plugin
+     * @param {App} app The application instance
+     */
+    init(app){
+        const router = express.Router();
+        const { rules } = app;
+
+        /**
+         * API: PUT /api/rule/ Create or update rule
+         * @function createOrUpdate
+         * @memberof RulesController
+         */
+        router.put('/', async (req, res)=>{
+
+        });
+
+        /**
+         * API: POST /api/rule/ List rules by given criteria
+         * @function list
+         * @returns {Rule[]}
+         * @memberof RulesController
+         */
+        router.post('/', async (req, res)=>{
+        })
+
+        /**
+         * API: GET /api/rule/:id Retrieve rule by ID
+         * @function read
+         * @param {string} id The id of the rule
+         * @returns {Rule}
+         * @memberof RulesController
+         */
+        router.get('/:id', async (req, res)=>{
+        })
+
+        /**
+         * API: DELETE /api/rule/:id Delete rule by ID
+         * @function remove
+         * @param {string} id The id of the rule
+         * @memberof RulesController
+         */
+        router.delete('/:id', async (req, res)=>{
+        })
+
+        app.webServer.xapp.use(this.route, router);
+    }
+}
+
+export { RulesController }