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

Zarządzanie dokumentacją Live Documentation

Włączanie dokumentacji Live Documentation

Aby udostępnić dokumentację API osobom spoza zespołu, musisz włączyć cechę Live Documentation.

Dopóki nie zostanie włączona, jest widoczna tylko jako podgląd dla użytkowników, którzy mają dostęp do definicji API.

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

Twoja dokumentacja Live Documentation jest teraz dostępna. Możesz kliknąć Otwórz, aby otworzyć ją w nowej karcie.

Wyłączanie dokumentacji Live Documentation

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

  1. Otwórz swoje API i przejdź do Otwórz ustawienia API.
  2. Przełącz przycisk Włączone z Wł. na Wył..
  3. Jeśli chcesz zwolnić subdomenę dokumentacji, wyczyść pole wyboru Zachowaj subdomenę dokumentacji Live API.
    Domyślnie API Designer zapisuje subdomenę zdefiniowaną podczas włączania dokumentacji Live Documentation. Pozwala to zachować ten sam adres URL w przypadku ponownego włączenia jej w przyszłości. Jeśli chcesz użyć tej subdomeny dla innego API, musisz ją najpierw zwolnić.
    Konfiguracja dokumentacji Live Documentation.
  4. Kliknij Zapisz.
Twoja dokumentacja Live Documentation jest wyłączona. Jeśli zachowałeś subdomenę, możesz ją ponownie włączyć w dowolnym momencie. Jeśli nie, 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ć!