5.3. Red Hat Quay Swagger UI へのアクセス


Red Hat Quay の管理者とユーザーは、実行可能コマンドをコンパイルする対話型 Web インターフェイスである Swagger UI を使用して API と対話できます。Swagger UI は、Red Hat Quay インスタンスの API 検出エンドポイント (/api/v1/discovery) を指すコンテナーとして起動できます。コンテナーをデプロイすると、指定された URL から Red Hat Quay の OpenAPI 仕様を読み込む Swagger UI にアクセスできます。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 がベアラートークンを受け入れるように設定されていないためです。その結果、各コマンドに対して、{"error": "CSRF token was invalid or missing."} のエラーが返されます。回避策として、このコマンドをターミナルにコピーし、ベアラートークンを手動で追加できます (例: -H 'Authorization: Bearer <bearer_token>')。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat