在 Linux 系统上配置 Swagger,通常需要以下几个步骤:
安装 Java 环境: Swagger 需要 Java 运行环境(JRE)或 Java 开发工具包(JDK)。你可以通过以下命令安装 OpenJDK:
sudo apt update
sudo apt install openjdk-11-jdk
验证安装:
java -version
安装 Maven: Swagger 使用 Maven 进行构建和依赖管理。你可以通过以下命令安装 Maven:
sudo apt install maven
验证安装:
mvn -version
克隆 Swagger 项目: 你可以从 Swagger 的官方 GitHub 仓库克隆 Swagger Core 项目:
git clone https://github.com/swagger-api/swagger-core.git
cd swagger-core
构建 Swagger Core: 使用 Maven 构建 Swagger Core 项目:
mvn clean install
配置 Swagger UI: Swagger UI 是一个基于 Web 的用户界面,用于查看和测试 API 文档。你可以从 Swagger 的官方 GitHub 仓库克隆 Swagger UI 项目:
git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
构建 Swagger UI: 使用 Maven 构建 Swagger UI 项目:
mvn clean install
部署 Swagger UI:
将构建好的 Swagger UI 文件复制到你的 Web 服务器目录中,例如 /var/www/html
。你可以使用以下命令将文件复制到该目录:
sudo cp -r target/swagger-ui-dist/* /var/www/html/
配置 Web 服务器:
确保你的 Web 服务器(如 Apache 或 Nginx)已经启动并运行。如果你使用的是 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>
然后启用该虚拟主机:
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;
}
}
然后启用该服务器块:
sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx
访问 Swagger UI:
打开浏览器,访问 http://localhost
,你应该能够看到 Swagger UI 的欢迎页面。
通过以上步骤,你已经在 Linux 系统上成功配置了 Swagger。