在 vLLM 中屏蔽 /docs(Swagger UI)和 /redoc 等自动生成的 API 文档页面,可以通过在启动命令中添加 --disable-fastapi-docs 参数来实现。
具体操作方法
在使用 vllm serve 或 python -m vllm.entrypoints.openai.api_server 启动服务时,加入以下参数:
-disable-fastapi-docs
示例命令
**方式一:使用 vllm serve 命令(推荐)**
vllm serve Qwen/Qwen-7B-Chat \ --host 0.0.0.0 \ --port 8000 \ --disable-fastapi-docs
方式二:使用 Python 模块启动
python -m vllm.entrypoints.openai.api_server \ --model Qwen/Qwen-7B-Chat \ --host 0.0.0.0 \ --port 8000 \ --disable-fastapi-docs
原理说明
vLLM 的 API 服务器基于 FastAPI 构建。默认情况下,FastAPI 会自动生成并暴露 Swagger UI (/docs) 和 ReDoc (/redoc) 页面。
当设置 --disable-fastapi-docs 为真时,vLLM 在初始化 FastAPI 应用时会显式地将 openapi_url、docs_url 和 redoc_url 设置为 None,从而禁用这些文档端点的访问。这不仅可以隐藏文档界面,还能略微减少服务器的内存占用和潜在的安全暴露面。
验证
启动服务后,尝试访问 http://<your-ip>:8000/docs,如果配置成功,将返回 404 Not Found 错误,而不是显示 Swagger UI 界面。