Feat: Add base ApiClient and implement About-Api

.gitignore

@@ -0,0 +1 @@
+.DS_Store

src/frontend/src/services/api/about-api.ts

@@ -0,0 +1,10 @@
+import type ApiBaseClient from "./base/api-base-client"
+
+export default (baseClient: ApiBaseClient) => {
+    return {
+        getAboutString: async () => {
+            const response = await baseClient.get<String>("services/api/external/about");
+            return response;
+        }
+    }
+}

src/frontend/src/services/api/base/api-base-client.ts

@@ -0,0 +1,156 @@
+import type { BaseResultBo } from "../../models/bo/base-result-bo";
+
+export default class ApiBaseClient {
+    apiBaseUrl: string = import.meta.env.VITE_APP_BACKEND;
+
+    /**
+     * GET functionality which handels errors, no try-catch needed for the caller
+     * @param route Route which should be called by the cliend - Route-Parameters must be included into the route by the caller
+     * @param params Query-params which will be included if provided
+     * @returns Allways returns a Promise<BaseResultBo<T>>
+     */
+    async get<T>(route: string, params?: Record<string, string>): Promise<BaseResultBo<T>> {
+        const query = new URLSearchParams(params).toString();
+        const url = `${this.apiBaseUrl}${route}${query ? "?" + query : ""}`;
+
+        try {
+            const response = await fetch(url, {
+                method: "GET",
+                headers: {
+                    "Accept": "application/json, text/plain, */*",
+                },
+            });
+
+            const contentType = response.headers.get("content-type");
+            let data: any;
+
+            if (contentType?.includes("application/json")) {
+                data = await response.json();
+            } else if (contentType?.includes("text/")) {
+                data = await response.text();
+            } else {
+                data = await response.blob();
+            }
+
+            const resObj: BaseResultBo<T> = {
+                data: data as T,
+                responseCode: response.status,
+                responseMessage: response.statusText,
+                isSuccess: response.ok,
+            };
+            return resObj;
+        } catch (e) {
+            return {
+                data: undefined,
+                responseCode: undefined,
+                responseMessage: e instanceof Error ? e.message : String(e),
+                isSuccess: false,
+            };
+        }
+    }
+
+    /**
+     * POST functionality which handels errors, no try-catch needed for the caller 
+     * @param route Route which should be called by the cliend - Route-Parameters must be included into the route by the caller
+     * @param input Object which is sent to the API. Object will not be validated, must be done by the caller
+     * @returns Always returns a BaseResultBo of type string which contains the uid of the created object
+     */
+    async post<T>(route: string, input: T): Promise<BaseResultBo<String>> {
+        const url = `${this.apiBaseUrl}${route}`;
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    "Content-Type": "application/json",
+                    "Accept": "application/json, text/plain, */*"
+                },
+                body: JSON.stringify(input)
+            });
+
+            const uid = await response.text();
+
+            const resObj: BaseResultBo<String> = {
+                data: uid,
+                responseCode: response.status,
+                responseMessage: response.statusText,
+                isSuccess: response.ok,
+            };
+            return resObj;
+        }
+        catch (e) {
+            return {
+                data: undefined,
+                responseCode: undefined,
+                responseMessage: e instanceof Error ? e.message : String(e),
+                isSuccess: false,
+            };
+        }
+    }
+
+    /**
+     * PUT functionality which handels errors, no try-catch needed for the caller 
+     * @param route Route which should be called by the cliend - Route-Parameters must be included into the route by the caller
+     * @param input Object which is sent to the API. Object will not be validated, must be done by the caller
+     * @returns Always returns a BaseResultBo of type string which contains the uid of the created object
+     */
+    async put<T>(route: string, input: T): Promise<BaseResultBo<String>> {
+        const url = `${this.apiBaseUrl}${route}`;
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers: {
+                    "Content-Type": "application/json",
+                    "Accept": "application/json, text/plain, */*"
+                },
+                body: JSON.stringify(input)
+            });
+
+            const uid = await response.text();
+
+            const resObj: BaseResultBo<String> = {
+                data: uid,
+                responseCode: response.status,
+                responseMessage: response.statusText,
+                isSuccess: response.ok,
+            };
+            return resObj;
+        }
+        catch (e) {
+            return {
+                data: undefined,
+                responseCode: undefined,
+                responseMessage: e instanceof Error ? e.message : String(e),
+                isSuccess: false,
+            };
+        }
+    }
+
+    /**
+     * 
+     * @param route The route called, the id of the deletion-item must be included in the url by the caller
+     * @returns Always returns a BaseResultBo of type undefined which only contains the response message and code
+     */
+    async delete(route: string): Promise<BaseResultBo<undefined>> {
+        const url = `${this.apiBaseUrl}${route}`;
+        try {
+            const response = await fetch(url, {
+                method: 'DELETE',
+            });
+
+            const resObj: BaseResultBo<undefined> = {
+                data: undefined,
+                responseCode: response.status,
+                responseMessage: response.statusText,
+                isSuccess: response.ok
+            }
+            return resObj;
+        } catch (e) {
+            return {
+                data: undefined,
+                responseCode: undefined,
+                responseMessage: e instanceof Error ? e.message : String(e),
+                isSuccess: false,
+            };
+        }
+    }
+}

src/frontend/src/services/api/index.ts

@@ -0,0 +1,8 @@
+import aboutApi from "./about-api";
+import ApiBaseClient from "./base/api-base-client";
+
+const apiBaseClient = new ApiBaseClient();
+
+export const services = {
+    about: aboutApi(apiBaseClient)
+}

src/frontend/src/services/models/bo/base-result-bo.ts

@@ -0,0 +1,6 @@
+export interface BaseResultBo<T> {
+    data?: T
+    responseCode?: number,
+    responseMessage: string,
+    isSuccess: boolean
+}