Developing an API Deprecation Tool for the API Developer

Abstract

In this thesis - a Minimum viable product (MVP) for an application aimed at making deprecation and removal of REST API endpoints safer - was developed. Previous work has shown that handling deprecations and removal of endpoints in REST APIs is a problem, with REST APIs not following deprecation-removal protocols nor giving the API consumers the information needed to properly update their software. This application is aimed at providing a simple way to monitor the usage of endpoints in a way that is relevant for deprecations, as well as providing the user with a simple automatic mailer to inform the API consumer of deprecations and upcoming removals of endpoints.
This was a collaboration with Homepal AB, a startup company providing data solutions for the real estate industry, who saw the importance of having a stable ecosystem between them - as the service and data provider - and their clients as the consumers of their service. Their service was comprised of a REST API where Homepal AB consolidated and processed data for their customers consuming systems, accessed via the different endpoints in their REST API. Given the fast paced development of Homepal AB as a startup company, they did not want to spend time on maintaining compatibility for deprecated endpoints and needed a way to make sure that their customers updated their consuming systems using endpoints intended for further development.
The papers focus is on how one can use certain user centred design methodology with an iterative approach in order to develop a useable MVP while having a small set of intended end users and being a single combined researcher, designer and developer.

Abstract (Swedish)

I detta arbete har en Minimum viable product (MVP) för en applikation utvecklats, som gör det säkrare att avveckla och ta bort endpoints för ett REST API. Tidigare arbete har visat att hanteringen av avvecklingen av endpoints i REST API:er är ett problem, där REST API:er inte följer protokoll för avveckling och borttagning. Applikationen är gjord för att tillhandahålla ett enkelt sätt att övervaka användningen av endpoints på ett sätt som är relevant för avveckling och borttagning, såväl som att ge användaren ett enkelt sätt att sätta upp automatiska mail-utskick för att informera API-konsumenten om avvecklingar och kommande borttagningar av endpoints.
Det här projektet var ett samarbete med Homepal AB, ett start-up-bolag som tillhandahåller datalösningar för fastighetsbranschen och som såg vikten av att ha ett stabilt ekosystem mellan dem, som service- och dataprovider, och deras kunder som dataconsumers av deras tjänst.
Deras tjänst bestod av ett REST API med en stor mängd endpoints där Homepal AB samlade och bearbetade data för sina kunders konsumerande system. Med Homepal AB:s snabba utveckling som startup-företag ville de inte lägga tid på att upprätthålla kompatibilitet för avvecklade endpoints och behövde ett sätt att säkerställa att deras kunder uppdaterade sina konsumerande system genom att använda de endpoints som var avsedda för fortsatt utveckling.
Arbetet fokuserar på hur man kan använda specifika användarcentrerade designmetoder i en iterativ process för att ta fram en användarvänlig MVP när man har en liten grupp avsedda användare och är en ensam kombinerad forskare, designer och utvecklare.

Popular Abstract (Swedish)

Utveckling av användarvänliga applikationer kan göras på många sätt, detta arbete fokuserar på hur man kan gå tillväga för en småskalig och kostnadseffektiv process.

• author: Persson, Johannes
• supervisor: Joakim Eriksson; Love Malmros
• organization: Ergonomics and Aerosol Technology
• alternative title: Att utveckla ett API-Avvecklingsverktyg för API-Utvecklare
• course: MAMM01 20242
• year: 2024
• type: H2 - Master's Degree (Two Years)
• subject: Technology and Engineering
• keywords: REST API, Deprecation, Useability, User Centered Design
• language: English
• id: 9175286
• date added to LUP: 2024-09-24 13:56:55
• date last changed: 2024-09-24 13:56:55