ubuntu下swagger如何运行

在Ubuntu系统下运行Swagger，你需要遵循以下步骤：

1. 安装Node.js和npm（如果尚未安装）： 打开终端，运行以下命令来安装Node.js和npm：

   sudo apt update
   sudo apt install nodejs npm
   

2. 安装Swagger UI： 使用npm全局安装Swagger UI：

   sudo npm install -g swagger-ui-express
   

3. 创建一个简单的Express应用（如果你还没有一个）： 在你的项目目录中，创建一个名为app.js的文件，并添加以下内容：

   const express = require('express');
       
   const app = express();
       
   const port = 3000;
       
   
   app.get('/', (req, res) =>
    {
       
     res.send('Hello World!');
   
   }
       );
       
   
   app.listen(port, () =>
    {
   
     console.log(`Example app listening at http://localhost:${
   port}
       `);
   
   }
       );
       
   

4. 在Express应用中集成Swagger UI： 修改app.js文件，添加Swagger UI中间件和配置：

   const express = require('express');
       
   const swaggerUi = require('swagger-ui-express');
       
   const YAML = require('yamljs');
       
   const swaggerDocument = YAML.load('./swagger.yaml');
        // 确保你有一个swagger.yaml文件
   
   const app = express();
       
   const port = 3000;
       
   
   app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
       
   
   app.get('/', (req, res) =>
    {
       
     res.send('Hello World!');
   
   }
       );
       
   
   app.listen(port, () =>
    {
   
     console.log(`Example app listening at http://localhost:${
   port}
       `);
   
   }
       );
       
   

5. 创建Swagger规范文件（swagger.yaml）： 在你的项目目录中创建一个名为swagger.yaml的文件，并添加你的API规范。例如：

   swagger: '2.0'
   info:
     title: Sample API
     description: A sample API to demonstrate Swagger integration
     version: '1.0.0'
   host: localhost:3000
   basePath: /
   schemes:
     - http
   paths:
     /:
       get:
         summary: Returns a hello message
         responses:
           '200':
             description: A successful response
             schema:
               type: string
   

6. 运行你的Express应用： 在终端中，导航到你的项目目录并运行以下命令：

   node app.js
   

7. 访问Swagger UI： 打开浏览器并访问http://localhost:3000/api-docs，你应该能看到Swagger UI界面，其中包含了你的API文档。

请确保你已经安装了所有必要的依赖，并且你的API规范文件（swagger.yaml）是正确的。如果有任何问题，请检查错误消息并进行相应的调整。

声明：本文内容由网友自发贡献，本站不承担相应法律责任。对本内容有异议或投诉，请联系2913721942#qq.com核实处理，我们将尽快回复您，谢谢合作！