Hantera Live Documentation | Qlik CloudHjälp
Gå till huvudinnehåll Gå till ytterligare innehåll

Hantera Live Documentation

Aktivera Live Documentation

För att dela din API-dokumentation med personer som inte är med i ditt team måste du aktivera Live Documentation-funktionen.

Tills den är aktiverad kan den endast visas som en förhandsgranskning för användare som har åtkomst till API-definitionen.

  1. Gå till sidan Inställningar för ditt API genom att klicka på Redigera > Öppna API-inställningar.
  2. Växla knappen Aktiverad från Av till och ange en URL.
    Konfiguration av Live Documentation.
  3. Välj synlighet. Om du väljer Lösenordsskyddad anger du ett lösenord i motsvarande fält.
  4. Klicka på Spara för att aktivera din Live Documentation.

Din Live Documentation är nu tillgänglig. Du kan klicka på Öppna för att öppna den på en ny flik.

Inaktivera Live Documentation

Inaktivera din dokumentation och välj om du vill behålla dess underdomän.

  1. Öppna ditt API och gå till Öppna API-inställningar.
  2. Växla knappen Aktiverad från till Av.
  3. Om du vill frigöra dokumentationens underdomän ska du radera kryssrutan Behåll underdomän för Live API-dokumentation.
    Som standard sparar API Designer den underdomän du definierade när du aktiverade Live Documentation. Detta gör att du kan behålla samma URL om du aktiverar den igen senare. Om du vill använda den här underdomänen för ett annat API måste du först frigöra den.
    Konfiguration av Live Documentation.
  4. Klicka på Spara.
Din Live Documentation är inaktiverad. Om du behöll underdomänen kan du aktivera den igen när som helst. Om inte kan underdomänen användas av ett annat API och du måste ange en underdomän om du vill aktivera den här dokumentationen igen.

Var den här sidan till hjälp för dig?

Om du stöter på några problem med den här sidan eller innehållet på den, t.ex. ett stavfel, ett saknat steg eller ett tekniskt fel – meddela oss!