[swagger]如何查看Swagger

### 如何查看Swagger UI或文档 对于想要查看由Swagger UI展示的OpenAPI文档，可以通过安装和配置Swagger UI来实现[^1]。如果是在特定框架下如FastAPI中离线使用Swagger UI，则需手动加载Swagger UI静态文件并与之集成[^2]。 通常情况下，当访问部署有Swagger UI的应用程序时，只需通过Web浏览器导航到相应的URL即可查看已设置好的Swagger文档界面。例如，默认情况下许多应用会将此路径设为`http://<your-server-address>/docs`或者`http://<your-server-address>/api-docs`。 另外，创建Swagger UI文档的过程涉及到了解YAML文件结构，其中定义了API的关键信息比如标题、版本以及描述等内容。一旦完成这些基础设定之后，在Swagger UI界面上就可以直观地浏览各个端点及其操作详情[^3]。 #### 示例：在线查看Swagger文档 假设有一个运行中的服务器地址为`example.com`，那么可以直接打开网页浏览器并输入类似下面这样的链接来进行查看： ``` http://example.com/docs ``` 或是针对某些系统可能是这样： ``` http://example.com/api-docs ``` #### 示例：离线环境下的准备与查看 如果是处于无法连接互联网的情况下工作，并希望利用Swagger UI进行API测试的话，可以按照以下方式处理： - 下载Swagger UI的相关静态资源文件至本地项目目录内； - 修改应用程序配置使得其指向本地存储的Swagger UI资源位置； - 运行应用程序后同样可通过上述提到的方式进入文档页面； ```python from fastapi import FastAPI import uvicorn app = FastAPI(docs_url="/documentation", redoc_url=None) if __name__ == "__main__": uvicorn.run(app, host="0.0.0.0", port=8000) ``` 在此基础上启动服务后，便可以在指定路径处找到Swagger UI所提供的交互式API文档视图。