在 Debian 上“安装 Swagger”通常有几种不同含义,最常见的是以下三种场景之一。你可以根据你的实际需求选择对应方案:
适合:前端或后端开发,想通过浏览器查看 OpenAPI 文档
sudo apt update
sudo apt install -y nginx git nodejs npm
cd /var/www
sudo git clone https://github.com/swagger-api/swagger-ui.git
编辑 Nginx 配置:
sudo nano /etc/nginx/sites-available/swagger
内容示例:
server {
listen 80;
server_name localhost;
location / {
root /var/www/swagger-ui/dist;
index index.html;
}
}
启用配置:
sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx
浏览器访问:
http://服务器IP
适合:编写和调试 API 文档
sudo apt install -y docker.io
sudo systemctl enable --now docker
sudo docker run -d -p 8080:8080 swaggerapi/swagger-editor
访问:
http://服务器IP:8080
pip install fastapi uvicorn
启动后自动访问:
http://localhost:8000/docs
添加依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
访问:
http://localhost:8080/swagger-ui.html
sudo apt install -y default-jre
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.41/swagger-codegen-cli-3.0.41.jar
java -jar swagger-codegen-cli-3.0.41.jar --help
| 需求 | 推荐方式 |
|---|---|
| 查看 API 文档 | Swagger UI |
| 编辑 API 文档 | Swagger Editor |
| 自动生成文档 | 框架集成 |
| 代码生成 | Swagger Codegen |
如果你能说明 “你用的是哪种语言/框架,想用 Swagger 做什么”,我可以给你更精确的 Debian 安装步骤。