如何在Ubuntu中集成Swagger與OAuth

在Ubuntu中集成Swagger與OAuth，可以按照以下步驟進行：

1. 安裝Swagger

首先，你需要安裝Swagger。你可以使用npm（Node.js的包管理器）來安裝Swagger。

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

2. 創建一個簡單的Express應用

接下來，創建一個簡單的Express應用，并集成Swagger。

mkdir swagger-oauth-example
cd swagger-oauth-example
npm init -y
npm install express swagger-ui-express

創建一個app.js文件，并添加以下代碼：

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

// Load Swagger document
const swaggerDocument = YAML.load('./swagger.yaml');

const app = express();

// Serve Swagger docs
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

3. 創建Swagger文檔

創建一個swagger.yaml文件，并定義你的API和OAuth配置。

swagger: '2.0'
info:
  title: Sample API
  description: A sample API with OAuth
  version: '1.0.0'
host: localhost:3000
basePath: /api
schemes:
  - http
paths:
  /protected:
    get:
      summary: Protected endpoint
      security:
        - OAuth2: []
definitions:
  OAuth2:
    type: object
    properties:
      access_token:
        type: string

4. 配置OAuth

為了使Swagger UI能夠處理OAuth，你需要配置一個OAuth提供者。你可以使用一個模擬的OAuth提供者，例如httpbin.org。

在app.js中添加OAuth配置：

const oauth = require('express-oauth');

// OAuth configuration
const oauthProvider = oauth({
  name: 'oauth2',
  baseUri: 'http://localhost:3000/api',
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  callbackUri: 'http://localhost:3000/auth/callback'
});

app.use('/auth', oauthProvider.authenticate());

app.get('/auth/callback', oauthProvider.callback({
  successRedirect: '/',
  failureRedirect: '/auth/failure'
}));

app.get('/auth/failure', (req, res) => {
  res.send('Authentication failed!');
});

5. 運行應用

現在，你可以運行你的Express應用：

node app.js

打開瀏覽器并訪問http://localhost:3000/api-docs，你應該能夠看到Swagger UI界面，并且可以測試受保護的端點。

總結

通過以上步驟，你已經在Ubuntu中成功集成了Swagger與OAuth。你可以根據需要進一步自定義和擴展這個示例，以滿足你的具體需求。