溫馨提示×

Ubuntu Swagger API文檔在哪查看

小樊
49
2025-07-19 10:36:52
欄目: 智能運維

在Ubuntu上查看Swagger API文檔,您可以通過以下幾種方法:

使用Docker安裝Swagger UI

  1. 安裝Docker:如果您還沒有安裝Docker,可以使用以下命令安裝:
sudo apt update
sudo apt install docker.io
  1. 拉取Swagger UI Docker鏡像:使用以下命令拉取Swagger UI的Docker鏡像:
docker pull swaggerapi/swagger-ui-express
  1. 運行Swagger UI容器:運行一個容器并映射端口(例如8080):
docker run -p 8080:8080 swaggerapi/swagger-ui-express
  1. 訪問Swagger UI:打開瀏覽器并訪問 http://localhost:8080 ,您應該能看到Swagger UI界面。

使用Node.js和Express安裝Swagger UI

  1. 安裝Node.js和npm:如果您還沒有安裝Node.js和npm,可以使用以下命令安裝:
sudo apt update
sudo apt install nodejs npm
  1. 創建一個新的Node.js項目:創建一個新的目錄并進入該目錄:
mkdir swagger-ui-project
cd swagger-ui-project
  1. 初始化npm項目
npm init -y
  1. 安裝Swagger UI Express
npm install swagger-ui-express
  1. 創建一個簡單的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));
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});
  1. 創建Swagger文檔:創建一個名為 swagger.yaml 的文件,并添加您的API文檔。例如:
swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI integration
  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
  1. 運行應用
node app.js
  1. 訪問Swagger UI:打開瀏覽器并訪問 http://localhost:3000/api-docs ,您應該能看到Swagger UI界面。

希望這些信息能幫助您在Ubuntu上找到并訪問Swagger API文檔。

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