在 Debian 上“分享 Swagger”一般有几种常见场景,下面按最常见用法给你说明,你可以看看哪种符合你的情况。
很多框架默认只监听 127.0.0.1,外网/局域网访问不了。
例如(Spring Boot):
springdoc:
swagger-ui:
enabled: true
确保服务监听:
ss -lntp | grep 8080
如果是:
127.0.0.1:8080
别人是访问不到的。
server:
address: 0.0.0.0
port: 8080
或 Nginx / 代码中显式绑定 0.0.0.0
sudo apt update
sudo apt install nginx
server {
listen 80;
server_name swagger.example.com;
location /swagger-ui/ {
proxy_pass http://127.0.0.1:8080/swagger-ui/;
}
location /v3/api-docs/ {
proxy_pass http://127.0.0.1:8080/v3/api-docs/;
}
}
重载:
sudo nginx -t
sudo systemctl reload nginx
别人访问:
http://服务器IP/swagger-ui.html
常见地址:
/v3/api-docs/v2/api-docscurl http://localhost:8080/v3/api-docs > openapi.json
python3 -m http.server 8000
访问:
http://服务器IP:8000/openapi.json
git clone https://github.com/swagger-api/swagger-ui.git
cp openapi.json swagger-ui/dist/
修改:
url: "openapi.json"
部署:
sudo cp -r swagger-ui/dist /var/www/html/swagger
访问:
http://服务器IP/swagger
Nginx 简单鉴权:
location /swagger-ui/ {
auth_basic "Swagger";
auth_basic_user_file /etc/nginx/.htpasswd;
}
我可以直接给你对应配置文件。