Swagger(现在通常指的是 OpenAPI Specification,简称 OAS)是一个用于生成、描述、调用和可视化 RESTful Web 服务的框架。在Ubuntu上安装和使用Swagger是可行的,但需要注意一些安装步骤和配置问题。以下是在Ubuntu上安装Swagger的详细步骤:
安装Swagger Editor和Swagger UI
- 安装Node.js和npm:
sudo apt-get updatesudo apt-get install nodejs npm
- 安装Swagger Editor:
npm install -g http-server
- 下载并解压Swagger Editor:
wget https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.zipunzip swagger-editor.zipcd swagger-editornpm start
- 安装Swagger UI:
git clone https://github.com/swagger-api/swagger-ui.gitcd swagger-uinpm install
- 启动Swagger UI:
npm run start
- 访问Swagger Editor和Swagger UI:
- Swagger Editor: http://localhost:8080
- Swagger UI: http://localhost:3000
使用Nginx搭建Swagger
- 安装Nginx:
sudo apt-get install nginx
- 下载Swagger Editor和Swagger UI:
wget https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.zipwget https://github.com/swagger-api/swagger-ui/releases/download/v3.47.1/swagger-ui.zipunzip swagger-editor.zipunzip swagger-ui.zip
- 配置Nginx:
编辑 /etc/nginx/sites-available/default
文件,添加以下内容:
server { listen 80; server_name localhost; location /swagger-editor { proxy_pass http://localhost:8080; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } location /swagger-ui { proxy_pass http://localhost:3000; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; }}
- 重启Nginx:
sudo systemctl restart nginx
- 访问Swagger Editor和Swagger UI:
- Swagger Editor: http://localhost/swagger-editor
- Swagger UI: http://localhost/swagger-ui
通过以上步骤,你可以在Ubuntu上成功安装和配置Swagger Editor和Swagger UI,或者使用Nginx作为反向代理来简化访问。这些工具对于API文档的生成和管理非常有用,可以提高开发效率和API的互操作性。