backend jsdoc

backend/routes/auth.js

@@ -1,17 +1,32 @@
+/** Express router
+ * @module routers/auth
+ * @requires express
+ */
+
 const express = require('express')
 const bcrypt = require('bcryptjs')
 const jwt = require('jsonwebtoken')
 const db = require('../database/models/index')
 const { ValidationError } = require('sequelize')
 
 const JWTKEY = process.env.JWTKEY
+
+/**
+ * Mount express router
+ * @type {object}
+ * @const
+ * @namespace authRouter
+ */
 const authRouter = express.Router()
 
 /**
- * Route sisäänkirjautumiseen ja käyttäjätilin luomiseen
- *
- * @category Kirjautuminen
- * @subcategory backend
+ * Sisäänkirjautuminen
+ * @name post/login
+ * @function
+ * @memberof module:routers/auth~authRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
  */
 
 authRouter.post('/login', async (req, res) => {
@@ -42,6 +57,16 @@ authRouter.post('/login', async (req, res) => {
     }
 })
 
+/**
+ * Rekisteröityminen
+ * @name post/register
+ * @function
+ * @memberof module:routers/auth~authRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 authRouter.post('/register', async (req, res) => {
     const credentials = req.body
     try {

backend/routes/events.js

@@ -1,19 +1,34 @@
+/** Express router
+ * @module routers/events
+ * @requires express
+ */
+
 const express = require('express')
 const axios = require('axios')
 const jwt = require('jsonwebtoken')
 
 const db = require('../database/models')
 const { BASEURL } = require('../config/index')
+
+/**
+ * Mount express router
+ * @type {object}
+ * @const
+ * @namespace eventsRouter
+ */
 const eventsRouter = express.Router()
+
 const JWTKEY = process.env.JWTKEY
 
 /**
- * Route Tapahtumien varausmäärän hakemiselle, arvostelun hakemiselle, poistamiselle ja päivittämiselle sekä tapahtumien fetchaukselle ja kategorioittain hakemiselle
- *
- * @category Tapahtumat
- * @subcategory backend
+ * Varausten tekeminen
+ * @name get/reservation/:id/:count
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
  */
-
 eventsRouter.get('/reservation/:id/:count', async (req, res) => {
     const token = req.headers.authorization
     const event_id = req.params.id
@@ -34,6 +49,16 @@ eventsRouter.get('/reservation/:id/:count', async (req, res) => {
     res.sendStatus(200)
 })
 
+/**
+ * Arvostelun luominen
+ * @name post/review/:id
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 eventsRouter.post('/review/:id/', async (req, res) => {
     const token = req.headers.authorization
     const event_id = req.params.id
@@ -53,6 +78,16 @@ eventsRouter.post('/review/:id/', async (req, res) => {
     }
 })
 
+/**
+ * Arvostelun poistaminen
+ * @name delete/review/:id/delete
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 eventsRouter.delete('/review/:id/delete', async (req, res) => {
     const token = req.headers.authorization
     const event_id = req.params.id
@@ -71,6 +106,16 @@ eventsRouter.delete('/review/:id/delete', async (req, res) => {
     }
 })
 
+/**
+ * Arvostelun päivitys
+ * @name post/review/:id/update
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 eventsRouter.post('/review/:id/update', async (req, res) => {
     const token = req.headers.authorization
     const event_id = req.params.id
@@ -91,6 +136,16 @@ eventsRouter.post('/review/:id/update', async (req, res) => {
     }
 })
 
+/**
+ * Tapahtuman hakeminen event idn perusteella
+ * @name get/:id/fetch
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 eventsRouter.get('/:id/:fetch', async (req, res) => {
     const id = req.params.id
     const fetch = req.params.fetch
@@ -138,6 +193,16 @@ eventsRouter.get('/:id/:fetch', async (req, res) => {
     }
 })
 
+/**
+ * Tapahtumien hakeminen tagin perusteella
+ * @name get/:lang/:limit/:tags
+ * @function
+ * @memberof module:routers/events~eventsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
+ */
+
 eventsRouter.get('/:lang/:limit/:tags', async (req, res) => {
     const language = req.params.lang
     const limit = req.params.limit

backend/routes/tags.js

@@ -1,14 +1,28 @@
+/** Express router
+ * @module routers/tags
+ * @requires express
+ */
+
 const express = require('express')
-const { Op } = require('sequelize')
 const db = require('../database/models/index')
 
+/**
+ * Mount express router
+ * @type {object}
+ * @const
+ * @namespace tagsRouter
+ */
+
 const tagsRouter = express.Router()
 
 /**
- * Route tagien hakemiselle
- *
- * @category Tagit
- * @subcategory backend
+ * Tagien hakeminen
+ * @name get/
+ * @function
+ * @memberof module:routers/tags~tagsRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
  */
 
 tagsRouter.get('/', async (req, res) => {
@@ -21,18 +35,4 @@ tagsRouter.get('/', async (req, res) => {
     }
 })
 
-tagsRouter.get('/:search', async (req, res) => {
-    const search = req.params.search
-    const matchTags = await db.Tag.findAll({
-        raw: true,
-        where: {
-            name: {
-                [Op.iLike]: '%' + search + '%',
-            },
-        },
-    })
-    const names = matchTags.map(x => x.name)
-    res.send(names)
-})
-
 module.exports = tagsRouter

backend/routes/user.js

@@ -1,17 +1,32 @@
+/** Express router
+ * @module routers/user
+ * @requires express
+ */
+
 const express = require('express')
 const db = require('../database/models/index')
 const jwt = require('jsonwebtoken')
 const axios = require('axios')
 const { BASEURL } = require('../config/index')
 
+/**
+ * Mount express router
+ * @type {object}
+ * @const
+ * @namespace userRouter
+ */
+
 const userRouter = express.Router()
 const JWTKEY = process.env.JWTKEY
 
 /**
- * Route käyttäjätietojen hakemiselle
- *
- * @category Käyttäjätiedot
- * @subcategory backend
+ * Käyttäjän tietojen hakeminen
+ * @name get/
+ * @function
+ * @memberof module:routers/user~userRouter
+ * @inner
+ * @param {string} path - Express path
+ * @param {callback} middleware - Express middleware.
  */
 
 userRouter.get('/', async (req, res) => {

jsdoc.conf.json

@@ -10,8 +10,7 @@
     ],
     "source": {
         "include": ["frontend/src", "backend/routes"],
-        "includePattern": ".+\\.js(doc|x)?$",
-        "excludePattern": "node_modules"
+        "includePattern": ".+\\.js(doc|x)?$"
     },
     "templates": {
         "better-docs": {