Verktyg För Apidokumentation

• Main Authors: Gårdebratt, Martin, Hagberg, Jonathan
• Format: Others
• Language: Swedish
• Published: Karlstads universitet, Institutionen för matematik och datavetenskap (from 2013) 2021
• Subjects: Data; API; Verktyg; React; Dokumentation; Anrop; Docusaurus; JavaScript; API-dokumentation; Askås; Computer Engineering; Datorteknik
• Online Access: http://urn.kb.se/resolve?urn=urn:nbn:se:kau:diva-84411

Med ett ökat antal API:er på internet ökar även behovet av anvisningar kring dessa. När användarna för API:er har olika nivåer av erfarenhet blir den nödvändiga dokumentationen och instruktionerna svårare att precisera från en utvecklares perspektiv. I detta projekt är målet att fastställa vad som utgör en bra dokumentation för ett API och tillämpa det för ett existerande API på begäran av Askås. Det befintliga materialet analyserades för att bygga en bättre förståelse för vilka API-anrop som stöttades, och skulle byggas om på ett sådant sätt att det skulle vara enkelt att implementera i Askås nya dokumentationssida. För att få klarhet kring vad som utgör bra API-dokumentation undersöktes fältstudier. Givet detta kunde arbetet utföras enligt etablerade studier tillsammans med kontinuerlig feedback från uppdragsgivaren. Resultatet är ett verktyg som kan användas för att göra API-anrop där parametrarna är förklarade på ett dynamiskt sätt som är byggt i React, uttryckt i Docusaurus, i väntan på att bli sammansatt i Askås nya dokumentationssida. === As the number of APIs on the internet increases, so does the need for guidance on how to use these. In APIs where the users have varying experience, the necessary documentation and instructions needed becomes harder to pinpoint from a developer's point of view. In this project, the objective is to conclude what constitutes a good documentation for an API and apply it to an existing API, as requested from Askås. The pre-existing material was analysed to build an understanding for which API calls were supported, and was to be re-built in such a way that it would be easily implemented in Askås' new API documentation site. To bring clarity to what constitutes good API documentation, field studies were examined. With this, the project could be executed according to the examined studies, as well as feedback from the client. The result is a tool that can be used to make API calls where the parametres are explained in a dynamic fashion - developed in React, expressed in Docusaurus, waiting to be merged into Askås new documentation site.