Hoe gebruik je Swagger?

Swagger is een interfacebeschrijvingstaal die RESTful-API's beschrijft die worden uitgedrukt met JSON. Hiermee kunt u interactieve, machinale en door mensen leesbare API documentationmaken. Het helpt u de bronnen van de API te visualiseren en ermee te communiceren zonder enige implementatielogica. Het is een webgebaseerde applicatie.

Documentatiesite van de Swagger

1. Open de documentatiesite van Swagger.

2. Als u de documentatie wilt verifiëren, klikt u op Autoriseren.
   Het deelvenster Beschikbare autorisaties verschijnt.

3. Voer het API-token in het veld Waarde in.

   NOTITIE

   U kunt een bestaand token selecteren of u kunt een nieuw token genereren volgens uw vereisten. Volg de onderstaande stappen om een nieuw token te genereren

   • Navigeer naar () in de linkernavigatiebalk in de Knowledge Base-portal.

   • Navigeer in het linkernavigatiedeelvenster naar Knowledge base portal > API-tokens.

   • Typ een naam voor het API-token in de naam van het token invoeren.

   • Selecteer de gewenste HTTP-methode(n). U heeft vier methoden onder Toegestane methode(n): GET, PUT, POST en DELETE.

   • U kunt het gegenereerde token alleen gebruiken voor de geselecteerde methode(n). Het kan niet worden gebruikt om andere methoden uit te voeren.

   • Klik op Kopiëren om het API-token te kopiëren.

4. Klik op de knop Autoriseren .

5. Als u klaar bent, klikt u op de Sluiten knop.
   De machtiging is succesvol uitgevoerd.

   

   NOTITIE

   Als u wilt overstappen op een ander token, klikt u op Autoriseren > Afmelden > voert u uw API-token in > Autoriseren > sluiten.

TOEVOEGEN

• De GET-methode wordt gebruikt om informatie op te halen.

• Hieronder ziet u een voorbeeld van een GET-actie om alle gegevens over het teamaccount op te halen.

1. Vul de gemarkeerde velden in en klik op de knop Uitvoeren .

   De informatie over het teamaccount is beschikbaar in de sectie Reacties .

VERZENDEN

• De POST-methode wordt gebruikt om een artikel toe te voegen.

• Hieronder zie je een voorbeeld van een POST-actie , om een teamaccount toe te voegen aan een project.

1. U moet de teamaccountgegevens toevoegen, zoals email_id, first_name en last_name om een gebruiker aan het project toe te voegen.
   Het teamaccount wordt toegevoegd aan het project.

2. Klik op de knop Uitvoeren .
   De toevoeging van het teamaccount is succesvol als de status 200 is en het succes waar is.

ZETTEN

• De PUT-methode wordt gebruikt om een bestaand artikel bij te werken.

• Hieronder ziet u een voorbeeld van een PUT-actie om een gebruikersrol in het project bij te werken.

1. Voer de userId in het gemarkeerde veld in.

2. Werk de gebruikersrol bij met het nummer dat wordt vermeld voor de syntaxis van de gebruikersrol. De nummers voor de respectievelijke rollen zijn als volgt:

   • 1 → Beheerder

   • 2 → Redacteur

   • 3 → Ontwerpschrijver

   • 4 → lezer

   • 7 → Eigenaar

3. Als u klaar bent, klikt u op de knop Uitvoeren .

   De update van de gebruiker is geslaagd als de status 200 is en het succes waar is.

VERWIJDEREN

• De DELETE-methode wordt gebruikt om een item te verwijderen.

• Hieronder ziet u een voorbeeld van een DELETE-actie om een userId te verwijderen.

1. Voer de userId in het gemarkeerde veld in.

2. Als u klaar bent, klikt u op de knop Uitvoeren .
   Als de status 200 is en het succes waar is, wordt de userId met succes verwijderd.

   

NOTITIE

Het is verplicht om de inhoud in te voeren in het veld dat is gemarkeerd met *verplicht.

 Raadpleeg de volgende blogs voor meer informatie

1. Ultieme gids voor het maken van een API-documentatie met voorbeelden

2. Feature spotlight – API in Document360