溫馨提示×

ubuntu swagger怎樣實現安全認證

小樊
44
2025-09-24 23:30:16
欄目: 智能運維

在Ubuntu上使用Swagger實現安全認證,通常涉及以下幾個步驟:

  1. 安裝Swagger: 首先,你需要在Ubuntu系統上安裝Swagger。你可以使用npm(Node.js的包管理器)來安裝Swagger。如果你還沒有安裝Node.js和npm,請先安裝它們。

    sudo apt update
    sudo apt install nodejs npm
    

    然后,使用npm安裝Swagger:

    sudo npm install -g swagger-jsdoc swagger-ui-express
    
  2. 配置Swagger: 創建一個Swagger配置文件,例如swagger.js,并定義你的API規范和安全方案。

    const swaggerJsDoc = require('swagger-jsdoc');
    
    const swaggerOptions = {
      definition: {
        openapi: '3.0.0',
        info: {
          title: 'My API',
          version: '1.0.0',
          description: 'A sample API',
        },
      },
      apis: ['./routes/*.js'], // 指定你的API路由文件
      securitySchemes: {
        bearerAuth: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
        },
      },
      security: [
        { bearerAuth: [] },
      ],
    };
    
    const swaggerDocs = swaggerJsDoc(swaggerOptions);
    module.exports = swaggerDocs;
    
  3. 集成Swagger UI: 在你的Express應用中集成Swagger UI,并使用之前創建的Swagger配置。

    const express = require('express');
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocs = require('./swagger');
    
    const app = express();
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
    
    // 其他路由和中間件
    
    const PORT = process.env.PORT || 3000;
    app.listen(PORT, () => {
      console.log(`Server is running on port ${PORT}`);
    });
    
  4. 實現安全認證: 在你的API路由中實現安全認證邏輯。例如,使用JWT(JSON Web Token)進行認證。

    const express = require('express');
    const jwt = require('jsonwebtoken');
    const router = express.Router();
    
    // 假設你有一個密鑰用于簽名和驗證JWT
    const JWT_SECRET = 'your_jwt_secret';
    
    // 登錄路由,生成JWT
    router.post('/login', (req, res) => {
      const { username, password } = req.body;
    
      // 驗證用戶名和密碼
      if (username === 'admin' && password === 'password') {
        const token = jwt.sign({ username }, JWT_SECRET, { expiresIn: '1h' });
        res.json({ token });
      } else {
        res.status(401).json({ message: 'Invalid credentials' });
      }
    });
    
    // 受保護的路由
    router.get('/protected', authenticateToken, (req, res) => {
      res.json({ message: 'This is a protected route' });
    });
    
    // JWT認證中間件
    function authenticateToken(req, res, next) {
      const authHeader = req.headers['authorization'];
      const token = authHeader && authHeader.split(' ')[1];
    
      if (token == null) return res.sendStatus(401);
    
      jwt.verify(token, JWT_SECRET, (err, user) => {
        if (err) return res.sendStatus(403);
        req.user = user;
        next();
      });
    }
    
    module.exports = router;
    
  5. 測試認證: 啟動你的Express應用,并訪問Swagger UI界面(通常是http://localhost:3000/api-docs)。嘗試訪問受保護的路由,確保你需要提供有效的JWT才能訪問。

通過以上步驟,你可以在Ubuntu上使用Swagger實現安全認證。確保你的密鑰(JWT_SECRET)是安全的,并且不要在生產環境中硬編碼敏感信息。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女