จะจัดทำเอกสาร nodejs API ที่มีอยู่ได้อย่างไร

ในที่สุดฉันก็สามารถทำให้มันใช้งานได้กับ swagger-jsdoc

ขั้นตอน

• เพิ่มแพ็กเกจ Swagger-UI

• เพิ่มการพึ่งพาผยอง-ui

  npm install -g swagger-ui

• กำหนดค่าผยองในไฟล์ server.js ของคุณ

  var swaggerJSDoc = require('swagger-jsdoc'); var options = { swaggerDefinition: { info: { title: 'Hello World', // Title (required) version: '1.0.0', // Version (required) }, }, apis: ['./routes.js'], // Path to the API docs }; var swaggerSpec = swaggerJSDoc(options); app.get('/api-docs.json', function(req, res) { res.setHeader('Content-Type', 'application/json'); res.send(swaggerSpec); }); app.use('/api/docs',express.static('./node_modules/swagger-ui/dist'));

• เพิ่มความคิดเห็นที่ผยองให้กับฟังก์ชันคอนโทรลเลอร์ของคุณ

/** * @swagger * resourcePath: /api * description: All about API */

/** * @swagger * /login: * post: * description: Login to the application * produces: * - application/json * parameters: * - name: username * description: Username to use for login. * in: formData * required: true * type: string * - name: password * description: User's password. * in: formData * required: true * type: string * responses: * 200: * description: login */ app.post('/login', function(req, res) { res.json(req.body); });

• มีเอกสารประกอบ Swagger อยู่ที่ http://localhost:3000/api/docs/?url=/api-docs.json