Application APIs

[uo282892]

This discussion is where the team can find and update the APIs of the different parts of the apllication, so everyone knows the needed interfaces to interact with the different parts of the application.

[uo282892]

Restapi

Interface/type of the data stored in the database

PlaceType = {
title: string;
uuid: string;
longitude: number;
latitude: number;
}

Operations

• GetPlaces: /api/places/list (GET)
• FindPlaceByTitle: /api/places/get/:title (GET)
• AddPlace: /api/places/add (POST)
• DeletePlace: /api/places/delete/:title (GET)
• UpdatePlace: /api/places/update/:title (POST)

Calls from webapp

In webapp/src/api/api.ts, we have methods with the same name as those in the restapi. Taking into account that all of them are promises, their signatures here are:

• PlaceType[] : GetPlaces ()
• PlaceType: FindPlaceByTitle (title: string)
• boolean: AddPlace (place: PlaceType)
• boolean: DeletePlace (title: string)
• boolean: UpdatePlace (title: string)