Podgląd technologii: wyświetlanie interfejsu REST API

Administrator klastra może użyć konsoli Red Hat® OpenShift® Container Platform (OCP) do określenia adresu URL dla interfejsu Swagger UI z interfejsem REST API WebSphere Automation .

Informacje o tej czynności

Interfejs REST API WebSphere Automation jest w tej wersji wersją wstępną do oceny technicznej i nie jest obsługiwany.

Procedura

  1. W konsoli OpenShift Container Platform kliknij opcję Sieć > Trasy.
  2. Aby uzyskać dostęp do interfejsu Swagger UI, należy postępować zgodnie z instrukcjami dla danej wersji produktu WebSphere Automation.
    • W przypadku systemu WebSphere Automation 1.4.3 i jego nowszych wersji:
      1. Na stronie Trasy znajdź pozycję cpd .
      2. Skopiuj adres URL w kolumnie Położenie .
      3. Otwórz nową kartę lub okno przeglądarki.
      4. Wklej adres URL skopiowany w kroku 3 w polu adresu przeglądarki, dodaj jedną z następujących ścieżek do adresu URL i naciśnij klawisz Enter.
        • W przypadku podstawowych interfejsów API dodaj następującą ścieżkę:
          /websphereauto/core/apis/openapi/ui/
        • W przypadku interfejsów API Health dodaj następującą ścieżkę:
          /websphereauto/health/apis/openapi/ui/
        • W przypadku interfejsów API bezpieczeństwa należy dodać następującą ścieżkę:
          /websphereauto/secvul/apis/openapi/ui/
    • W przypadku wersji WebSphere Automation 1.4.2 i wcześniejszych:
      1. Na stronie Trasy znajdź jeden z następujących wpisów.
        • Dla bezpieczeństwa: wsa-secure-apis
        • W przypadku poprawności: wsa-healing-rest
      2. Kliknij adres URL w kolumnie Położenie .

        Pod tym adresem URL zostanie otwarte puste okno przeglądarki.

      3. Kliknij pole adresu przeglądarki, dodaj łańcuch /openapi/ui do istniejącego adresu URL i naciśnij klawisz Enter.
    W oknie przeglądarki zostanie otwarty interfejs Swagger UI.
  3. Kliknij opcję Autoryzuj.
    Zostanie otwarte okno dialogowe Dostępne autoryzacje .
  4. W polu tekstowym Wartość wprowadź wartość tokenu dla profilu autoryzowanego użytkownika.
    Aby uzyskać token:
    1. Uzyskaj hasło dla konta administratora.
      oc -n WSA_INSTANCE_NAMESPACE get secret admin-user-details -o jsonpath='{.data.initial_admin_password}' | base64 -d && echo

      WSA_INSTANCE_NAMESPACE to przestrzeń nazw instancji, w której zainstalowano produkt WebSphere Automation . Jeśli podczas instalacji wybrano wartość domyślną, wartością jest websphere-automation.

    2. Zastąp wartość <password> w poniższej komendzie wartością zwróconą przez komendę w poprzednim kroku i użyj poprawnej wartości dla parametru WSA_INSTANCE_NAMESPACE.
      curl -k -X POST -H 'Content-Type: application/json' -d '{"username":"admin","password":"<password>"}' https://$(oc get route -n WSA_INSTANCE_NAMESPACE -o jsonpath='{.items[?(@.spec.to.name=="ibm-nginx-svc")].spec.host}')/icp4d-api/v1/authorize | jq -r .token
    Aby uzyskać więcej informacji, skontaktuj się z administratorem klastra.

Wyniki

Po pomyślnym autoryzowaniu przy użyciu poprawnego znacznika można użyć interfejsu Swagger UI, aby wyświetlić interfejs REST API WebSphere Automation .