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

流程

  1. 输入以下命令来部署 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
    Copy to Clipboard Toggle word wrap

    输出示例

    ---
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
    20-envsubst-on-templates.sh: Running envsubst on /etc/nginx/templates/default.conf.template to /etc/nginx/conf.d/default.conf
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/40-swagger-ui.sh
    /docker-entrypoint.sh: Configuration complete; ready for start up
    ---
    Copy to Clipboard Toggle word wrap

  2. 导航到 localhost URL。在这个示例中,它是 http://localhost:8080/
  3. 使用 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>'

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat