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
を設定している。
手順
次のコマンドを入力して 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 がベアラートークンを受け入れるように設定されていないためです。その結果、各コマンドに対して、
{"error": "CSRF token was invalid or missing."}
のエラーが返されます。回避策として、このコマンドをターミナルにコピーし、ベアラートークンを手動で追加できます (例:-H 'Authorization: Bearer <bearer_token>'
)。