Swagger在Linux下如何配置 - 问答

在Linux下配置Swagger主要分为两个部分：安装Swagger Editor和Swagger UI。以下是详细的步骤：

安装Swagger Editor

安装Node.js和npm：

首先，确保你的系统上已经安装了Node.js和npm。如果没有安装，可以参考Node.js的官方文档进行安装。

下载并解压Swagger Editor：

创建一个新的目录来存放Swagger Editor，例如/opt/swagger-editor。
使用wget下载Swagger Editor的最新版本，并解压到该目录。

配置全局路径：

编辑~/.bashrc文件，添加以下行以将Swagger Editor的可执行文件路径添加到全局路径中：
```
export PATH=$PATH:/opt/swagger-editor/bin
```
使更改立即生效：
```
source ~/.bashrc
```

启动Swagger Editor：

在Swagger Editor目录中，执行以下命令启动服务：
```
http-server -p 8080
```
打开浏览器，访问http://your_server_ip:8080，即可使用Swagger Editor。

安装Swagger UI

下载Swagger UI：

从Swagger的官方GitHub仓库克隆Swagger UI项目：

git clone https://github.com/swagger-api/swagger-ui.git

构建Swagger UI：

进入Swagger UI目录，使用Maven构建项目：
```
cd swagger-ui
mvn clean install
```

部署Swagger UI：

将构建好的Swagger UI文件复制到你的Web服务器目录中，例如/var/www/html：
```
sudo cp -r target/swagger-ui-dist/* /var/www/html/
```

配置Web服务器：

如果你使用的是Apache：

创建一个虚拟主机配置文件，例如/etc/apache2/sites-available/swagger.conf：

<VirtualHost *:80>
    ServerName localhost
    DocumentRoot /var/www/html
    <Directory /var/www/html>
        Options Indexes FollowSymLinks AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

启用该虚拟主机并重启Apache：

sudo a2ensite swagger.conf
sudo systemctl reload apache2

如果你使用的是Nginx：

创建一个服务器块配置文件，例如/etc/nginx/sites-available/swagger：

server {
    listen 80;
    server_name localhost;
    root /var/www/html;
    index index.html;
    location / {
        try_files $uri $uri/ /index.html;
    }
}

启用该服务器块并重启Nginx：

sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

访问Swagger UI：

打开浏览器，访问http://your_server_ip，即可看到Swagger UI的欢迎页面。

以上步骤应该可以帮助你在Linux系统上成功配置Swagger Editor和Swagger UI。如果在配置过程中遇到任何问题，请参考相关的官方文档或寻求社区帮助。

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

0 赞

0 踩