5.3. 访问 Red Hat Quay Swagger UI
Red Hat Quay 管理员和用户可使用 Swagger UI - 一个编译可执行文件的交互式 Web 界面与 API 交互。Swagger UI 可以作为容器启动,该容器指向 Red Hat Quay 实例的 API 发现端点(/api/v1/discovery
)。部署容器后,您可以访问 Swagger UI,该 UI 从指定的 URL 加载 Red Hat Quay 的 OpenAPI 规格。Red Hat Quay 管理员和用户可探索可用的端点及其结构。
使用以下步骤访问 Red Hat Quay Swagger UI。
先决条件
-
您已在
config.yaml
文件中设置了BROWSER_API_CALLS_XHR_ONLY: false
。
流程
输入以下命令来部署 Swagger UI 容器,将 URL 指向 Red Hat Quay 的 API 发现端点。例如:
podman run -p 8080:8080 -e SWAGGER_JSON_URL=<quay-server.example.com> docker.swagger.io/swaggerapi/swagger-ui
$ podman run -p 8080:8080 -e SWAGGER_JSON_URL=<quay-server.example.com> docker.swagger.io/swaggerapi/swagger-ui
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
导航到
localhost
URL。在这个示例中,它是 http://localhost:8080/。 使用 Swagger UI 测试各种 API 端点。例如,要为用户创建新令牌,您可以点击 POST /api/v1/user/apptoken endpoint
Try it out Execute 生成示例 curl
命令。注意目前,无法生成服务器响应。这是因为 Swagger UI 没有设置为接受 bearer 令牌。因此,每个命令会返回以下错误:
{"error": "CSRF token is invalid or missing."}
。作为临时解决方案,您可以将此命令复制到终端中,并手动添加 bearer 令牌,如-H 'Authorization: Bearer <bearer_token>'