Question

Below is code for setting up my swagger which is in main.ts file

const swaggerOptions={
    swaggerDefinition:{
        info:{
            title:'Data Api',
            version:'1.0.1',
            description:'ToDo API',

            host:'localhost:7000',
            basePath:'/'
        }
    },
    apis:['./routes/product.route.ts'][enter image description here][1]
};
const swaggerdocs=swaggerjsdoc(swaggerOptions);
app.get('/swagger.json',(req:Request,res:Response)=>{
    res.setHeader('Content-Type','application/json');
    res.send(swaggerdocs);
});

app.use('/api-docs',swaggeruiexpress.serve,swaggeruiexpress.setup(swaggerdocs));

并且我正在'./routes/product.route.ts'文件中定义以下定义，该文件必须显示在swagger UI中，但问题仍然存在，我只能看到“规格”。

/**
 * @swagger
 * /getAllItems:
 *   get:
 *     summary: List all the Objects
 *     description: Returns a list of all the user names
 *     tags:
 *       - Values
 *     parameters:
 *      name: 
 *             type:string
 *         _id: 
 *              type:string
 *     produces:
 *       - application/json
 *     responses:
 *       200:
 *         description: Successful
 *          400:
 *          description: Bad Request..Try again later
 *          _id:
 *                 type: string
 *          name:
 *              type:string
 */

Answer 1

成功了！！由于API附近的命名约定不太明显：'./ routes / products.route.ts'

谢谢！

规范中未定义任何操作！ ---无法定义定义--- node.ts，swaggerUI

1 个答案: