Skip to main content

Why is my Node.js api not added to swagger?

I'm trying to add Swagger to my apis in my Node.js project. I have the following project structure:

▼ src
    ▼ app
        ▼ api
            ▼ routes
                GroupsRoutes.js
    main.js

My main.js file is inside the src folder on the same level as the app folder.

The GroupsRoutes.js file looks like this:

const express = require('express');
const { default: mongoose } = require('mongoose');
const router = express.Router();
const Groups = require('../../models/group');
const Devices = require('../../models/device');
const Applications = require('../../models/application');

/**
* @swagger
* /api/organizations/:orgId/groups:
*   get:
*     description: Get all groups
*     responses:
*       200:
*         description: Success
*/
router.get('/organizations/:orgId/groups', async (req, res) => {
    try {
        const orgId = req.params.orgId;

        let groups;
        groups = await Groups.find({ orgId: orgId });

        return res.status(200).json(groups);
    } catch (err) {
        return res.status(500).json({ message: err.message });
    }
});

module.exports = router;

Then I have the main.js file that looks like this:

import * as express from 'express';

const swaggerJsDoc = require('swagger-jsdoc');
const swaggerUI = require('swagger-ui-express');

const app = express();

const mongoose = require('mongoose');

...

app.use(express.json());

const groupsRouter = require('./app/api/routes/GroupsRoutes');
app.use('/api', groupsRouter);

const swaggerOptions = {
    swaggerDefinition: {
        info: 
            title: 'Groups Service',
            version: '1.0.0'
        }
    },
    apis: ['app/api/routes/GroupsRoutes.js'],
};

const swaggerDocs = swaggerJsDoc(swaggerOptions);
console.log(swaggerDocs);
app.use('/api-docs', swaggerUI.serve, swaggerUI.setup(swaggerDocs));

So basically my endpoints in GroupsRoutes.js works perfectly, but for some reason the swagger is just empty saying 'No operations defined in spec!'. The console log in the main.js logs prints out the following:

{
  info: { title: 'Groups Service', version: '1.0.0' },
  swagger: '2.0',
  paths: {},
  definitions: {},
  responses: {},
  parameters: {},
  securityDefinitions: {},
  tags: []
}

Why is my get endpoint not added to swagger?

Via Active questions tagged javascript - Stack Overflow https://ift.tt/DpwSUNz

Comments

Popular posts from this blog

How to show number of registered users in Laravel based on usertype?

i'm trying to display data from the database in the admin dashboard i used this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count(); echo $users; ?> and i have successfully get the correct data from the database but what if i want to display a specific data for example in this user table there is "usertype" that specify if the user is normal user or admin i want to user the same code above but to display a specific usertype i tried this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count()->WHERE usertype =admin; echo $users; ?> but it didn't work, what am i doing wrong? source https://stackoverflow.com/questions/68199726/how-to-show-number-of-registered-users-in-laravel-based-on-usertype

Why is my reports service not connecting?

I am trying to pull some data from a Postgres database using Node.js and node-postures but I can't figure out why my service isn't connecting. my routes/index.js file: const express = require('express'); const router = express.Router(); const ordersCountController = require('../controllers/ordersCountController'); const ordersController = require('../controllers/ordersController'); const weeklyReportsController = require('../controllers/weeklyReportsController'); router.get('/orders_count', ordersCountController); router.get('/orders', ordersController); router.get('/weekly_reports', weeklyReportsController); module.exports = router; My controllers/weeklyReportsController.js file: const weeklyReportsService = require('../services/weeklyReportsService'); const weeklyReportsController = async (req, res) => { try { const data = await weeklyReportsService; res.json({data}) console...

How to split a rinex file if I need 24 hours data

Trying to divide rinex file using the command gfzrnx but getting this error. While doing that getting this error msg 'gfzrnx' is not recognized as an internal or external command Trying to split rinex file using the command gfzrnx. also install'gfzrnx'. my doubt is I need to run this program in 'gfzrnx' or in 'cmdprompt'. I am expecting a rinex file with 24 hrs or 1 day data.I Have 48 hrs data in RINEX format. Please help me to solve this issue. source https://stackoverflow.com/questions/75385367/how-to-split-a-rinex-file-if-i-need-24-hours-data