add json endpoints to HTTP API

BenediktAlkin · Nov 6, 2021 · 40d7dd8 · 40d7dd8
1 parent 7659c36
commit 40d7dd8
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 2 deletions.
diff --git a/BackendAPI/Constants.cs b/BackendAPI/Constants.cs
@@ -5,5 +5,7 @@ public static class Constants
         public const string NONE = "NONE";
         public const string SOME = "SOME";
         public const string ALL = "ALL";
+
+        public const string JSON_RESULT = "result";
     }
 }
diff --git a/BackendAPI/Controllers/AlbumController.cs b/BackendAPI/Controllers/AlbumController.cs
@@ -1,6 +1,7 @@
 using Backend;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 
@@ -45,6 +46,9 @@ public async Task<bool[]> AssignTag(string tag, [FromQuery] string id)
             return success;
         }
 
+        [HttpPost("json/tags/{tag}/album")]
+        public async Task<Dictionary<string, bool[]>> JsonAssignTag(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await AssignTag(tag, id) } };
+
 
         [HttpDelete("tags/{tag}/album")]
         public async Task<bool[]> DeleteAssignment(string tag, [FromQuery] string id)
@@ -72,6 +76,9 @@ public async Task<bool[]> DeleteAssignment(string tag, [FromQuery] string id)
 
             return success;
         }
+        [HttpDelete("json/tags/{tag}/album")]
+        public async Task<Dictionary<string, bool[]>> JsonDeleteAssignment(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await DeleteAssignment(tag, id) } };
+
 
         [HttpGet("tags/{tag}/album")]
         public async Task<string> IsTagged(string tag, [FromQuery] string id)
@@ -103,5 +110,7 @@ public async Task<string> IsTagged(string tag, [FromQuery] string id)
             return tracksAreTagged;
         }
 
+        [HttpGet("json/tags/{tag}/album")]
+        public async Task<Dictionary<string, string>> JsonIsTagged(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await IsTagged(tag, id) } };
     }
 }
diff --git a/BackendAPI/Controllers/ConnectionController.cs b/BackendAPI/Controllers/ConnectionController.cs
@@ -1,6 +1,7 @@
 using Backend;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 
@@ -43,5 +44,8 @@ public string UserId()
             timer.DetailMessage = $"userId={user.Id}";
             return user.Id;
         }
+
+        [HttpGet("json/connection/userid")]
+        public Dictionary<string, string> JsonUserId() => new() { { Constants.JSON_RESULT, UserId() } };
     }
 }
diff --git a/BackendAPI/Controllers/PlaylistController.cs b/BackendAPI/Controllers/PlaylistController.cs
@@ -1,6 +1,7 @@
 using Backend;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 
@@ -44,6 +45,8 @@ public async Task<bool[]> AssignTag(string tag, [FromQuery] string id)
 
             return success;
         }
+        [HttpPost("json/tags/{tag}/playlist")]
+        public async Task<Dictionary<string, bool[]>> JsonAssignTag(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await AssignTag(tag, id) } };
 
 
         [HttpDelete("tags/{tag}/playlist")]
@@ -72,6 +75,9 @@ public async Task<bool[]> DeleteAssignment(string tag, [FromQuery] string id)
 
             return success;
         }
+        [HttpDelete("json/tags/{tag}/playlist")]
+        public async Task<Dictionary<string, bool[]>> JsonDeleteAssignment(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await DeleteAssignment(tag, id) } };
+
 
         [HttpGet("tags/{tag}/playlist")]
         public async Task<string> IsTagged(string tag, [FromQuery] string id)
@@ -102,6 +108,7 @@ public async Task<string> IsTagged(string tag, [FromQuery] string id)
             timer.DetailMessage = $"result={tracksAreTagged}";
             return tracksAreTagged;
         }
-
+        [HttpGet("json/tags/{tag}/playlist")]
+        public async Task<Dictionary<string, string>> JsonIsTagged(string tag, [FromQuery] string id) => new() { { Constants.JSON_RESULT, await IsTagged(tag, id) } };
     }
 }
diff --git a/BackendAPI/Controllers/TagController.cs b/BackendAPI/Controllers/TagController.cs
@@ -27,6 +27,8 @@ public string[] GetTags()
             timer.DetailMessage = $"result={string.Join(',', allTags)}";
             return allTags;
         }
+        [HttpGet("json/tags")]
+        public Dictionary<string, string[]> JsonGetTags() => new() { { Constants.JSON_RESULT, GetTags() } };
 
         [HttpGet("taggroups")]
         public Dictionary<string, string[]> GetTagGroups()
@@ -42,5 +44,7 @@ public Dictionary<string, string[]> GetTagGroups()
             timer.DetailMessage = $"result={{{msg}}}";
             return groups;
         }
+        [HttpGet("json/taggroups")]
+        public Dictionary<string, Dictionary<string, string[]>> JsonGetTagGroups() => new() { { Constants.JSON_RESULT, GetTagGroups() } };
     }
 }
diff --git a/BackendAPI/Controllers/TrackController.cs b/BackendAPI/Controllers/TrackController.cs
@@ -43,6 +43,8 @@ public async Task<bool[]> AssignTag(string tag, [FromQuery(Name = "id")] string[
 
             return success;
         }
+        [HttpPost("json/tags/{tag}/tracks")]
+        public async Task<Dictionary<string, bool[]>> JsonAssignTag(string tag, [FromQuery(Name = "id")] string[] ids) => new() { { Constants.JSON_RESULT, await AssignTag(tag, ids) } };
 
 
         [HttpDelete("tags/{tag}/tracks")]
@@ -63,6 +65,9 @@ public bool[] DeleteAssignment(string tag, [FromQuery(Name = "id")] string[] ids
 
             return success;
         }
+        [HttpDelete("json/tags/{tag}/tracks")]
+        public Dictionary<string, bool[]> JsonDeleteAssignment(string tag, [FromQuery(Name = "id")] string[] ids) => new() { { Constants.JSON_RESULT, DeleteAssignment(tag, ids) } };
+
 
         [HttpGet("tags/{tag}/tracks")]
         public string IsTagged(string tag, [FromQuery(Name = "id")] string[] ids)
@@ -85,6 +90,7 @@ public string IsTagged(string tag, [FromQuery(Name = "id")] string[] ids)
             timer.DetailMessage = $"result={tracksAreTagged}";
             return tracksAreTagged;
         }
-
+        [HttpGet("json/tags/{tag}/tracks")]
+        public Dictionary<string, string> JsonIsTagged(string tag, [FromQuery(Name = "id")] string[] ids) => new() { { Constants.JSON_RESULT, IsTagged(tag, ids) } };
     }
 }
diff --git a/BackendAPI/documentation.md b/BackendAPI/documentation.md
@@ -2,6 +2,10 @@
 
 Running "BackendAPI.exe" will start a HTTP server on http://localhost:63848/ with the following endpoints.
 
+## JSON format
+All endpoints described here use text/plain as return type. The return value is wrapped into a json object when an endpoint is prefixed with json/.
+E.g. If the endpoint GET connection/userid returns *exampleuserid* the endpoint GET json/connection/userid will return *{"result":"exampleuserid"}*
+
 ## Connection
 The API does need access to the SpotifyAPI. Upon starting the API it will check if a user is already logged in. If no user is logged in it will open a browser window for the user to login. The login for the API is independent of the login for the main app. A user remains logged into the API until the logout endpoint is called.