Zarządzanie dokumentacją na żywo | Qlik Cloud Pomoc
Przeskocz do zawartości głównej Przejdź do treści uzupełniającej

Zarządzanie dokumentacją na żywo

Ostatnia aktualizacja: 20.10.2026

Włączanie dokumentacji na żywo

Aby udostępnić swoją dokumentację API osobom, które nie należą do Twojego zespołu, musisz włączyć cechę Live Documentation.

Dopóki nie zostanie włączone, jest widoczne wyłącznie jako podgląd dla użytkowników mających dostęp do definicji API.

  1. Przejdź do strony Ustawienia swojego API, klikając Edytuj > Otwórz ustawienia API.
  2. Przełącz przycisk Włączone z pozycji Wył. na Wł. i wprowadź adres URL.
    Konfiguracja dokumentacji na żywo.
  3. Wybierz widoczność. Jeśli wybierzesz opcję Chronione hasłem, wprowadź hasło w odpowiednim polu.
  4. Kliknij Zapisz, aby włączyć Live Documentation.

Twoja dokumentacja na żywo jest już dostępna. Możesz kliknąć Otwórz, aby otworzyć go w nowej karcie.

Wyłączanie dokumentacji na żywo

Wyłącz swoją dokumentację i wybierz, czy chcesz zachować jej subdomenę.

  1. Otwórz swoje API i przejdź do ustawień Open API.
  2. Przełącz przycisk Włączone z Wł. na Wył..
  3. Jeśli chcesz zwolnić poddomenę dokumentacji, należy czyścić pole wyboru Zachowaj poddomenę aktywnej dokumentacji API.
    Domyślnie API Contracts zapisuje subdomenę zdefiniowaną podczas włączania Live Documentation. Pozwala to zachować ten sam adres URL, jeśli włączysz go ponownie później. Jeśli chcesz użyć tej subdomeny dla innego API, musisz ją najpierw zwolnić.
    Konfiguracja dokumentacji na żywo.
  4. Kliknij Zapisz.
Twoja Live Documentation jest wyłączona. Jeśli subdomena została zachowana, możesz ją włączyć ponownie w dowolnym momencie. W przeciwnym razie subdomena może zostać użyta przez inne API i konieczne będzie wprowadzenie subdomeny, jeśli zechcesz ponownie włączyć tę dokumentację.

Czy ta strona była pomocna?

Jeżeli natkniesz się na problemy z tą stroną lub jej zawartością — literówkę, brakujący krok lub błąd techniczny — daj nam znać!