Aitun julkiset rajapinnat on dokumentoitu Swagger työkalun avulla. Käytännössä asennetussa Aitu-sovelluksessa on mukana dokumentaatio, joka vastaa toteutusta koska se generoidaan toteutuksen perusteella.

Dokumentaatio löytyy osoitteesta /api-docs/index.html. Esimerkiksi QA-ympäristössä tämä osoite on: https://testi.virkailija.opintopolku.fi/aitu/api-docs/index.html

 

Esimerkki siltä miltä dokumentaatio näyttää. Kunkin rajapinnan alta saa lisätietoja kyseisestä rajapinnasta ja siitä millaista dataa rajapinta ottaa vastaan tai palauttaa ulospäin.

  • No labels