swagger在ubuntu上的集成方法

2025年7月22日 互联网

在Ubuntu上集成Swagger UI可以通过多种方法实现，以下是几种常见的方法：

方法一：使用Docker

  1. 安装Docker：
    如果你还没有安装Docker，可以使用以下命令安装：
sudo apt update
sudo apt install docker.io
  1. 拉取Swagger UI Docker镜像：
docker pull swaggerapi/swagger-ui-express
  1. 运行Swagger UI容器：
docker run -p 8080:8080 swaggerapi/swagger-ui-express
  1. 访问Swagger UI：
    打开浏览器并访问 http://localhost:8080，你应该能看到Swagger UI界面。

方法二：使用Node.js和Express

  1. 安装Node.js和npm：
sudo apt update
sudo apt install nodejs npm
  1. 创建一个新的Node.js项目：
mkdir swagger-ui-project
cd swagger-ui-project
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
        format: int64
      username:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      email:
        type: string
        format: email
      password:
        type: string
        format: password
      phoneNumber:
        type: string
        format: phone
      active:
        type: boolean
        default: true
      dateCreated:
        type: string
        format: date-time
      updated:
        type: string
        format: date-time
      id:
        $ref: '#/definitions/User'
  1. 运行应用：
node app.js
  1. 访问Swagger UI：
    打开浏览器并访问 http://localhost:3000/api-docs，你应该能看到Swagger UI界面。

方法三：使用Snap包管理器

  1. 安装Snap包管理器：
sudo snap refresh
  1. 安装Swagger UI：
sudo snap install swagger-ui
  1. 启动Swagger UI：
    安装完成后，可以通过以下命令启动Swagger UI：
swagger-ui

这将在默认浏览器中打开Swagger UI界面。

方法四：使用npm全局安装

  1. 安装Node.js和npm（如果尚未安装）：
sudo apt update
sudo apt install nodejs npm
  1. 全局安装Swagger UI：
sudo npm install -g swagger-ui-express
  1. 创建一个简单的Express应用并集成Swagger UI：
    创建一个新的目录并进入该目录：
mkdir swagger-demo
cd swagger-demo

创建一个 index.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();

// Use swagger-ui-express middleware
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: This is a sample API documentation for Swagger.
  version: 1.0.0
host: localhost:8080
basePath: /api
schemes:
  - http
paths:
  /users:
    get:
      summary: Get list of users
      description: Returns a list of all users
      produces:
        - application/json
      responses:
        '200':
          description: A list of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
definitions:
  User:
    type: object
    properties:
      id:
        type: integer
        format: int64
      username:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      email:
        type: string
        format: email
      password:
        type: string
        format: password
      phoneNumber:
        type: string
        format: phone
      active:
        type: boolean
        default: true
      dateCreated:
        type: string
        format: date-time
      updated:
        type: string
        format: date-time
      id:
        $ref: '#/definitions/User'
  1. 启动应用：
node index.js
  1. 访问Swagger UI：
    在浏览器中访问 http://localhost:3000/api-docs。

通过以上几种方法，你可以在Ubuntu上成功集成Swagger UI，并查看和测试你的API文档。选择适合你的方法并按照步骤操作即可。

最新文章