feat: Add sample-requests.http for testing API locally (#46)

Add sample-requests.http. This allows you to run the system locally and test HTTP requests to easily verify that the endpoints work as expected. You can run .http files in IntelliJ IDEA and it will display whether the requests succeeded or failed. This is a faster alternative than opening the Swagger UI to test the endpoints.

Author: thorlauridsen

requests/sample-requests.http

@@ -0,0 +1,56 @@
+# This is a sample HTTP request file for testing purposes
+# You can run the application locally and execute these requests in IntelliJ IDEA to test the API
+
+### Create a new customer with a mail address
+POST http://localhost:8080/customers
+Content-Type: application/json
+
+{
+  "mail": "bob@gmail.com"
+}
+
+> {%
+    client.test("Customer created successfully", function () {
+        client.assert(response.status === 201, "Response status is not 201");
+
+        const body = typeof response.body === 'string'
+            ? JSON.parse(response.body)
+            : response.body;
+
+        client.assert(
+            body.mail && body.mail === "bob@gmail.com",
+            "Response body does not contain the expected mail"
+        );
+
+        client.assert(
+            body.id,
+            "Response body does not contain an id"
+        );
+
+        client.global.set("customerId", body.id);
+    });
+%}
+
+### Get the created customer by ID from previous request
+GET http://localhost:8080/customers/{{customerId}}
+Accept: application/json
+
+> {%
+    client.test("Customer retrieved successfully", function () {
+        client.assert(response.status === 200, "Response status is not 200");
+
+        const body = typeof response.body === 'string'
+            ? JSON.parse(response.body)
+            : response.body;
+
+        client.assert(
+            body.mail && body.mail === "bob@gmail.com",
+            "Response body does not contain the expected mail"
+        );
+
+        client.assert(
+            body.id && body.id === client.global.get("customerId"),
+            "Response body does not contain the expected id"
+        );
+    });
+%}