search

virtuella-team / vteam-sds

0 stars 0 forks source link

API-delen inte klar i main? #29

Closed patrikmalvenius closed 1 year ago

patrikmalvenius commented 1 year ago

Noterar att det står så här:

Dokumentation

För att underlätta för tredjepartsleverntörer att bygga externa tjänster och applicationer är REST-API’et väldokumenterat.

Länk till dokumentationen?
Ett exempel från dokumentationen på en enskild endpoint?

För min del kan det räcka med den första meningen, alltså strunta i exempel på dokumentation?

tomas-zw commented 1 year ago

Joel och jag pratade lite om det idag, och för tillfället så finns det ingen sån dokumentation. Och är lite tveksam att vi har ett komplett API doc till fre. Men att skapa doc för en route och länka till en WIP kan funka.

sonnerberg commented 1 year ago

Jag lägger en stund på att undersöka hur det kan göras i Postman.

sonnerberg commented 1 year ago

Efter att ha tittat runt lite på Postman så skulle jag säga att det är ett lovande verktyg, men att man nog får läsa på / kolla video för att komma igång med att skapa API-dokumentation genom Postman.

Man kan samarbeta i ett workspace mellan konton om man vill.

Joel80 commented 1 year ago

Vi går på Patriks förslag