Swagger在Ubuntu上如何配置 - 问答

在Ubuntu上配置Swagger通常涉及以下几个步骤：

安装Swagger工具

基于Debian的系统（如Ubuntu）：
1. 更新包列表：
```
sudo apt-get update
```
2. 安装Swagger工具：
```
sudo apt-get install swagger-jsdoc swagger-ui-express
```
基于Red Hat的系统（如Fedora）：
1. 更新包列表：
```
sudo dnf update
```
2. 安装Swagger工具：
```
sudo dnf install swagger-jsdoc swagger-ui-express
```
使用Node.js环境：
1. 安装Node.js和npm（如果尚未安装）：
```
sudo apt-get install nodejs npm
```
2. 使用npm安装Swagger工具：
```
npm install swagger-jsdoc swagger-ui-express --save-dev
```

配置Swagger

创建一个Swagger配置文件，通常命名为swagger.json或swagger.yaml。这个文件定义了API的元数据，包括API的路径、操作、参数、模型等。

以下是一个简单的swagger.json示例：

{
  "swagger": "2.0",
  "info": {
    "description": "Sample API",
    "version": "1.0.0"
  },
  "basePath": "/api",
  "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"
        }
      }
    }
  }
}

集成Swagger到你的应用

如果你使用的是Express框架，可以按照以下方式集成Swagger UI：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');
const app = express();

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}`);
});

运行你的应用

运行你的Node.js应用，然后访问http://localhost:3000/api-docs（或者你设置的相应端口），你应该能看到Swagger UI界面，其中包含了你的API文档。

使用Swagger Editor和Swagger UI进行API监控和测试

安装Node.js和npm（如果尚未安装）：
```
sudo apt update
sudo apt install nodejs npm
```

安装Swagger Editor：

方法一：从官网下载并解压Swagger Editor：

wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gztar -xvf v3.16.1.tar.gz
cd swagger-editor-3.16.1
npm install
npm install -g http-server
http-server -p 8080

方法二：使用npm全局安装Swagger Editor：
```
npm install -g swagger-editor
```

安装Swagger UI：

方法一：从官网下载并解压Swagger UI：

wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gztar -xvf v3.48.0.tar.gz
cd swagger-ui-3.48.0
npm install
npm install -g express node index.js

方法二：使用npm全局安装Swagger UI：
```
npm install -g swagger-ui
```

配置Swagger Editor和Swagger UI：
- Swagger Editor：启动后访问http://localhost:8080，使用你保存的Swagger YAML文件进行API文档的编辑和查看。
- Swagger UI：启动后访问http://localhost:3000，在页面中输入你的Swagger YAML文件的URL，然后点击“Explore”按钮查看和测试API。

通过以上步骤，你可以在Ubuntu上成功安装和配置Swagger，从而进行API的监控和管理。

0 赞

0 踩