ubuntu

如何在Ubuntu上安装Swagger

小樊
44
2025-03-28 09:01:01
栏目: 智能运维
Ubuntu服务器限时活动,0元免费领! 查看>>

在Ubuntu上安装Swagger,你可以选择安装Swagger UI或者Swagger Editor。以下是两种方法的详细步骤:

方法一:安装Swagger UI

  1. 更新系统包列表

    sudo apt update
    
  2. 安装Swagger UI 你可以通过npm(Node.js的包管理器)来安装Swagger UI。首先,确保你已经安装了Node.js和npm。

    sudo apt install nodejs npm
    

    然后,使用npm全局安装Swagger UI:

    sudo npm install -g swagger-ui-express
    
  3. 启动Swagger UI 创建一个简单的Express服务器来托管Swagger UI。

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

    创建一个名为server.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}`);
    });
    

    创建一个名为swagger.yaml的文件,并添加你的Swagger文档。

    启动服务器:

    node server.js
    

    现在,你可以在浏览器中访问http://localhost:3000/api-docs来查看Swagger UI。

方法二:安装Swagger Editor

  1. 更新系统包列表

    sudo apt update
    
  2. 安装Swagger Editor 你可以通过npm来安装Swagger Editor。

    sudo npm install -g swagger-editor
    
  3. 启动Swagger Editor 启动Swagger Editor:

    swagger-editor
    

    这将在默认浏览器中打开Swagger Editor。

注意事项

通过以上步骤,你应该能够在Ubuntu上成功安装并运行Swagger UI或Swagger Editor。

亿速云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>

相关推荐:如何在Debian上安装Swagger

0
看了该问题的人还看了