Hoe gebruik je Swagger

Swagger is een interface description language die RESTful API's beschrijft die met JSON worden uitgedrukt. Het stelt je in staat om interactieve, machine- en mensleesbare API-documentatie te maken. Het helpt je om de middelen van de API te visualiseren en ermee te interageren zonder enige implementatielogica. Het is een webgebaseerde applicatie.

Swagger-documentatiesite

1. Open de Swagger-documentatiesite.

2. Om de documentatie te authenticeren, klik op Autoriseren.
   Het panel Beschikbare autorisaties zal verschijnen.

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

   OPMERKING

   Je kunt een bestaande token selecteren, of je kunt een nieuwe token genereren volgens jouw wensen. Om een nieuwe token te genereren, volgt u de onderstaande stappen

   • Navigeer naar () in de linker navigatiebalk in het Kennisbankportaal.

   • Ga in het linker navigatiepaneel naar Knowledge base portal > API-tokens.

   • Typ een naam voor het API-token in de Enter-tokennaam.

   • Selecteer de vereiste HTTP-methode(s). Je hebt vier methoden onder Toegestane methode(s): GET, PUT, POST en DELETE.

   • Je kunt alleen het gegenereerde token gebruiken voor de geselecteerde methode(s). 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 je klaar bent, klik dan op de knop Sluiten .
   De autorisatie wordt succesvol uitgevoerd.

   

   OPMERKING

   Als je wilt overstappen naar een ander token, klik dan op Autoriseren > Uitloggen > voer je API-token in > Autoriseren > Sluiten.

GA

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

• Hieronder staat een voorbeeld van een GET-actie , om alle gegevens over de gebruiker op te halen.

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

   De informatie over de gebruiker is beschikbaar onder het gedeelte Reacties .

POST

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

• Hieronder staat een voorbeeld van een POST-actie , om een gebruiker aan een project toe te voegen.

1. Je moet gebruikersinformatie toevoegen zoals email_id, first_name en last_name om een gebruiker aan het project toe te voegen.
   De gebruiker wordt aan het project toegevoegd.

2. Klik op de Uitvoeren-knop .
   De toevoeging van de gebruiker zal succesvol zijn als de status 200 is en het succes klopt.

PUT

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

• Hieronder volgt 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 voor de syntaxis van de gebruikersrol wordt vermeld. De nummers voor de respectievelijke rollen zijn als volgt:

   • 1 → Administrator

   • 2 → Redacteur

   • 3 → Conceptschrijver

   • 4 → Lezer

   • 7 → Eigenaar

3. Als je klaar bent, klik je op de Uitvoeren-knop .

   De update van de gebruiker is succesvol als de status 200 is en het succes klopt.

VERWIJDEREN

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

• Hieronder staat een voorbeeld van een DELETE-actie , om een userId te verwijderen.

1. Voer de userId in het gemarkeerde veld in.

2. Als je klaar bent, klik je op de Uitvoeren-knop .
   Als de status 200 is en het succes klopt, wordt de userId succesvol verwijderd.

   

OPMERKING

Het is verplicht om de inhoud in het veld in te voeren die als *verplicht is gemarkeerd.

 Voor meer informatie, zie de volgende blogs

1. Ultieme gids om een API-documentatie met voorbeelden te maken

2. Feature spotlight – API in Document360