Linux環境下Swagger如何與Docker容器配合使用

在Linux環境下，將Swagger與Docker容器配合使用可以幫助你更好地管理和部署API文檔。以下是一個基本的步驟指南：

1. 創建Swagger配置文件

首先，你需要創建一個Swagger配置文件（通常是swagger.yaml或swagger.json），描述你的API接口。

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger with Docker
  version: '1.0.0'
paths:
  /hello:
    get:
      summary: Returns a hello message
      responses:
        '200':
          description: A successful response
          schema:
            type: string

2. 創建Dockerfile

接下來，創建一個Dockerfile來構建包含Swagger UI的Docker鏡像。

# 使用官方的Node.js運行時作為基礎鏡像
FROM node:14

# 設置工作目錄
WORKDIR /usr/src/app

# 復制Swagger配置文件到工作目錄
COPY swagger.yaml .

# 安裝Swagger UI Express
RUN npm install swagger-ui-express

# 創建一個簡單的Express應用來提供Swagger UI
FROM express:latest

# 復制Swagger UI Express應用到工作目錄
COPY --from=0 /usr/src/app /usr/src/app

# 設置Swagger UI Express
EXPOSE 3000
CMD ["node", "./swagger-ui-express.js"]

3. 構建Docker鏡像

在包含Dockerfile的目錄中運行以下命令來構建Docker鏡像：

docker build -t swagger-ui-express .

4. 運行Docker容器

構建完成后，運行Docker容器來啟動Swagger UI：

docker run -p 3000:3000 swagger-ui-express

5. 訪問Swagger UI

打開瀏覽器并訪問http://localhost:3000，你應該能夠看到Swagger UI界面，并且可以加載你的Swagger配置文件。

6. 集成到現有應用

如果你已經有一個現有的Node.js應用，你可以將Swagger UI Express集成到你的應用中，而不是使用單獨的Docker容器。以下是一個簡單的示例：

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

const app = express();

// 加載Swagger配置文件
const swaggerDocument = YAML.load('./swagger.yaml');

// 使用Swagger UI Express中間件
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}`);
});

然后，你可以像之前一樣構建和運行Docker容器：

docker build -t my-api .
docker run -p 3000:3000 my-api

通過這種方式，你可以輕松地將Swagger UI集成到你的現有應用中，并利用Docker進行部署和管理。