如何利用Ubuntu Swagger進行API文檔管理

以下是在Ubuntu上利用Swagger進行API文檔管理的步驟：

1. 安裝Swagger工具：
   • 基于Debian系統（如Ubuntu），更新包列表后安裝swagger-jsdoc和swagger-ui-express：sudo apt-get update，sudo apt-get install swagger-jsdoc swagger-ui-express。
   • 也可通過Node.js和npm安裝，先安裝Node.js和npm，再執行npm install swagger-jsdoc swagger-ui-express --save-dev。
2. 創建Swagger規范文件：創建swagger.json或swagger.yaml文件，定義API元數據，如路徑、操作、參數等。例如：

swagger: '2.0'
info:
  description: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List all users
      responses:
        '200':
          description: An array of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
definitions:
  User:
    type: object
    properties:
      id:
        type: integer
      name:
        type: string

3. 配置Swagger：若使用Express框架，創建一個Express應用，引入swagger-ui-express和Swagger文檔，將其集成到應用中，如app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));。
4. 運行應用：運行Node.js應用，訪問http://localhost:3000/api-docs（端口可自定義），查看Swagger UI界面及API文檔。
5. 可選：使用Docker部署：安裝Docker，創建Dockerfile，將Swagger相關文件復制到容器中，構建并運行容器，通過相應端口訪問Swagger UI。