Products
96SEO 2025-07-15 03:30 1
在开头部署Swagger之前, 确保你的Ubuntu系统已经安装了以下柔软件和工具:
先说说你需要安装Docker。能通过以下命令安装Docker:
sudo apt-get update
sudo apt-get install docker.io
sudo systemctl start docker
sudo systemctl enable docker
接下来安装Node.js和npm。能用以下命令安装:
sudo apt-get update
sudo apt-get install nodejs npm
Swagger Editor和Swagger UI能通过Docker容器进行安装。先说说 拉取Swagger Editor和Swagger UI的Docker镜像:
docker pull swaggerapi/swagger-editor
docker pull swaggerapi/swagger-ui-express
在部署Swagger之前,你需要创建一个Swagger文档。这通常是一个YAML文件,说说了你的API接口。
打开Swagger Editor,你能在这里创建和编辑你的Swagger文档。保存你的文档为Swagger文件。
接下来你需要将Swagger文档转换为一个能展示的HTML文件。能用Swagger UI来实现。
眼下 你已经有了Swagger文档,接下来是部署Swagger UI来展示你的API文档。
用以下命令运行Swagger UI容器, 并映射端口:
docker run -d -p 8080:8080 swaggerapi/swagger-ui-express
如果你希望用Nginx来反向代理Swagger UI,你需要创建一个新鲜的Nginx配置文件。
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup
sudo nano /etc/nginx/sites-available/my-swagger
在配置文件中,修改server块的root和index指向你的Swagger文档所在的目录。
server {
listen 80;
server_name localhost;
root /path/to/your/swagger-document;
index index.html index.htm index.php;
location / {
try_files $uri $uri/ /index.html;
}
}
保存并关闭配置文件, 然后沉启Nginx服务以应用更改:
sudo systemctl restart nginx
眼下你能你的API接口。
你的API接口。
Demand feedback