Ubuntu Swagger如何添加认证 - 问答

在Swagger中添加认证，通常是为了确保API的安全性。以下是在Ubuntu上使用Swagger（特别是Swagger UI）添加认证的一般步骤：

1. 安装Swagger UI

首先，你需要安装Swagger UI。你可以使用npm来安装：

sudo apt update
sudo apt install npm
sudo npm install -g swagger-ui-express

2. 创建一个简单的Express应用

mkdir swagger-auth-app
cd swagger-auth-app

然后，创建一个app.js文件：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');

// 读取Swagger文档
const swaggerDocument = YAML.load('./swagger.yaml');

const app = express();

// 添加Swagger UI中间件
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

// 启动服务器
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

3. 创建Swagger文档

创建一个swagger.yaml文件，并添加认证信息。以下是一个示例：

swagger: '2.0'
info:
  title: Sample API
  description: A sample API with authentication
  version: '1.0.0'
host: localhost:3000
basePath: /api
schemes:
  - http
paths:
  /protected:
    get:
      summary: Protected endpoint
      security:
        - bearer: []
      responses:
        200:
          description: Successful response

在这个示例中，我们定义了一个受保护的端点/protected，并使用bearer认证方案。

4. 添加认证中间件

在你的app.js文件中，添加一个认证中间件来验证JWT令牌。你可以使用jsonwebtoken库来生成和验证JWT令牌。

首先，安装jsonwebtoken库：

npm install jsonwebtoken

然后，在app.js中添加认证中间件：

const jwt = require('jsonwebtoken');

// 用于验证JWT令牌的密钥
const JWT_SECRET = 'your-secret-key';

// 认证中间件
const 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();
  });
};

// 使用认证中间件保护端点
app.get('/api/protected', authenticateToken, (req, res) => {
  res.json({ message: 'This is a protected endpoint', user: req.user });
});

5. 运行应用

现在，你可以运行你的应用：

node app.js

打开浏览器并访问http://localhost:3000/api-docs，你应该能够看到Swagger UI界面，并且可以测试受保护的端点。

6. 获取JWT令牌

为了测试受保护的端点，你需要先获取一个JWT令牌。你可以创建一个登录端点来生成令牌：

app.post('/api/login', (req, res) => {
  const { username, password } = req.body;

  // 这里应该有实际的用户验证逻辑
  if (username === 'admin' && password === 'password') {
    const user = { username: 'admin' };
    const accessToken = jwt.sign(user, JWT_SECRET);
    res.json({ accessToken });
  } else {
    res.status(401).json({ message: 'Invalid credentials' });
  }
});

现在，你可以使用Postman或其他工具向http://localhost:3000/api/login发送POST请求来获取JWT令牌，然后使用该令牌访问受保护的端点。

通过这些步骤，你可以在Ubuntu上使用Swagger UI添加认证功能。

0 赞

0 踩