python swagger flask 访问地址
时间: 2025-04-17 11:32:23 浏览: 28
### 如何在Python Flask应用中设置和访问Swagger UI URL
为了在Flask项目中配置并访问Swagger UI,需先安装`flask-swagger-ui`模块。这可以通过执行命令 `pip install flask-swagger-ui` 来完成[^1]。
接着,在应用程序代码里引入必要的包,并创建一个Flask实例:
```python
from flask import Flask
from flasgger import Swagger
app = Flask(__name__)
Swagger(app)
```
上述代码片段展示了如何初始化Flask应用并与Swagger集成[^2]。
对于具体的API文档定义,则可以采用YAML文件来描述API的行为。例如,读取名为`api_docs.yaml`的文件作为API文档的内容,并将其应用于特定路由上:
```python
with open('api_docs.yaml', 'r') as f:
SWAGGER_YAML = f.read()
@app.route('/hello', methods=['GET'])
@swag_from_yaml(SWAGGER_YAML)
def hello():
return jsonify(message="Hello, World!")
```
这段代码说明了怎样加载外部YAML格式的API文档,并指定给某个HTTP端点使用。
一旦完成了这些步骤,启动Flask服务器之后,默认情况下Swagger UI将会自动挂载到路径 `/apidocs` 下面。因此,只要浏览器访问形如 `http://localhost:5000/apidocs` 这样的URL(假设本地运行且默认端口为5000),就可以看到完整的交互式API文档界面[^4]。
阅读全文
相关推荐


















