Merge pull request #33 from IlyaChichkov/develop

Develop v1.3.0

Author: IlyaChichkov

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "1.2.2",
+      "version": "1.3.0",
       "commands": [
         "csharpier"
       ],

.github/workflows/deploy.yml

@@ -35,6 +35,8 @@ jobs:
           pip install mkdocs-material
           pip install mkdocs-mermaid2-plugin
           pip install mkdocs-minify-plugin
+          pip install mkdocs-macros-plugin
+          pip install mkdocs-llmstxt
 
       - name: Build site
         run: mkdocs build --site-dir public

About/About.xml

@@ -4,7 +4,7 @@
   <description>RIMAPI is a mod that give you an REST API useable for your current game</description>
   <packageId>RedEyeDev.RIMAPI</packageId>
   <author>RedEyeDev</author>
-  <modVersion>1.2.2</modVersion>
+  <modVersion>1.3.0</modVersion>
   <url></url>
   <supportedVersions>
     <li>1.5</li>

About/Manifest.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Manifest>
     <identifier>redeyedev.rimapi</identifier>
-    <version>1.2.2</version>
+    <version>1.3.0</version>
     <manifestUri>
         https://raw.githubusercontent.com/IlyaChichkov/RIMAPI/refs/heads/main/About/Manifest.xml</manifestUri>
     <downloadUri>https://github.com/IlyaChichkov/RIMAPI/releases</downloadUri>

CHANGELOG.md

@@ -1,4 +1,31 @@
 # Changelog
+## v1.3.0
+
+Add examples and description for endpoints in documentation
+
+Insert them into auto generated api.md by macroses from api.yml
+
+Add option to use json body for endpoints that accept parameters:
+- /api/v1/dev/console
+- /api/v1/colonist/time-assignment
+
+Add new endpoints:
+[GET]
+
+- /api/v1/world/caravans
+- /api/v1/world/settlements
+- /api/v1/world/caravans
+- /api/v1/world/tile
+
+[POST]
+- /api/v1/pawn/edit
+
+Fixes:
+- TraitDefDto empty label, description
+- /api/v1/colonist/body/image returned GetColonistInventory
+- change "throw new Exception" to "return ApiResult.Fail"
+- /api/v1/dev/console didn't have message parameter
+
 ## v1.2.2
 
 Fix GetItemImageByName

Source/RIMAPI/RIMAPI_Settings.cs

@@ -5,7 +5,7 @@ namespace RIMAPI
 {
     public class RIMAPI_Settings : ModSettings
     {
-        public string version = "1.2.0";
+        public string version = "1.3.0";
         public string apiVersion = "v1";
         public int serverPort = 8765;
         public int refreshIntervalTicks = 300;

Source/RIMAPI/RimApi.csproj

@@ -6,7 +6,7 @@
     <RootNamespace>RIMAPI</RootNamespace>
     <AssemblyName>RIMAPI</AssemblyName>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <Version>1.2.2</Version>
+    <Version>1.3.0</Version>
   </PropertyGroup>
 
   <!-- Conditional properties for RimWorld 1.5 -->

Source/RIMAPI/RimworldRestApi/BaseControllers/DevToolsController.cs

@@ -20,8 +20,21 @@ public DevToolsController(IDevToolsService gameStateService)
         [EndpointMetadata("Send message to the debug console")]
         public async Task PostConsoleAction(HttpListenerContext context)
         {
-            var action = RequestParser.GetStringParameter(context, "action");
-            var result = _devToolsService.ConsoleAction(action);
+            DebugConsoleRequest body;
+            if (context.Request.HasEntityBody)
+            {
+                body = await context.Request.ReadBodyAsync<DebugConsoleRequest>();
+            }
+            else
+            {
+                body = new DebugConsoleRequest
+                {
+                    Action = RequestParser.GetStringParameter(context, "action"),
+                    Message = RequestParser.GetStringParameter(context, "message"),
+                };
+            }
+
+            var result = _devToolsService.ConsoleAction(body);
             await context.SendJsonResponse(result);
         }
 
@@ -44,8 +57,8 @@ public async Task PostMaterialsAtlasPoolClear(HttpListenerContext context)
         [EndpointMetadata("Change stuff color")]
         public async Task PostStuffColor(HttpListenerContext context)
         {
-            var requestData = await context.Request.ReadBodyAsync<StuffColorRequest>();
-            var result = _devToolsService.SetStuffColor(requestData);
+            var body = await context.Request.ReadBodyAsync<StuffColorRequest>();
+            var result = _devToolsService.SetStuffColor(body);
             await context.SendJsonResponse(result);
         }
     }

Source/RIMAPI/RimworldRestApi/BaseControllers/GameController.cs

@@ -30,14 +30,14 @@ ICachingService cachingService
         public async Task EnableCache(HttpListenerContext context)
         {
             _cachingService.SetEnabled(true);
-            await ResponseBuilder.Success(context.Response, new { message = "Cache enabled" });
+            await ResponseBuilder.SendSuccess(context.Response, new { message = "Cache enabled" });
         }
 
         [Post("/api/v1/cache/disable")]
         public async Task DisableCache(HttpListenerContext context)
         {
             _cachingService.SetEnabled(false);
-            await ResponseBuilder.Success(context.Response, new { message = "Cache disabled" });
+            await ResponseBuilder.SendSuccess(context.Response, new { message = "Cache disabled" });
         }
 
         [Get("/api/v1/cache/status")]
@@ -47,34 +47,15 @@ public async Task GetCacheStatus(HttpListenerContext context)
             var stats = _cachingService.GetStatistics();
             var status = new { enabled = _cachingService.IsEnabled(), statistics = stats };
 
-            await ResponseBuilder.Success(context.Response, status);
-        }
-
-        [Get("/api/v1/cache/stats")]
-        [EndpointMetadata("Get cache statistics")]
-        public async Task GetCacheStats(HttpListenerContext context)
-        {
-            var stats = _cachingService.GetStatistics();
-            await ResponseBuilder.Success(
-                context.Response,
-                new
-                {
-                    stats.TotalEntries,
-                    stats.Hits,
-                    stats.Misses,
-                    stats.HitRatio,
-                    MemoryUsageMB = stats.MemoryUsageBytes / 1024 / 1024,
-                    stats.LastCleanup,
-                }
-            );
+            await ResponseBuilder.SendSuccess(context.Response, status);
         }
 
         [Post("/api/v1/cache/clear")]
         [EndpointMetadata("Clear cache")]
         public async Task ClearCache(HttpListenerContext context)
         {
             _cachingService.Clear();
-            await ResponseBuilder.Success(context.Response, new { message = "Cache cleared" });
+            await ResponseBuilder.SendSuccess(context.Response, new { message = "Cache cleared" });
         }
 
         [Get("/api/v1/version")]
@@ -153,7 +134,7 @@ public async Task GetWorldTileDatetime(HttpListenerContext context)
         }
 
         [Get("/api/v1/def/all")]
-        [EndpointMetadata("Get in-game date and time in global map tile", new[] { "Unstable" })]
+        [EndpointMetadata("Get in-game date and time in global map tile")]
         public async Task GetAllDefs(HttpListenerContext context)
         {
             var body = await context.Request.ReadBodyAsync<AllDefsRequestDto>();

Source/RIMAPI/RimworldRestApi/BaseControllers/GlobalMapController.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Linq;
+using System.Net;
+using System.Threading.Tasks;
+using RIMAPI.Core;
+using RIMAPI.Http;
+using RIMAPI.Services;
+
+namespace RIMAPI.Controllers
+{
+    public class GlobalMapController : BaseController
+    {
+        private readonly IGlobalMapService _globalMapService;
+        private readonly ICachingService _cachingService;
+
+        public GlobalMapController(IGlobalMapService globalMapService, ICachingService cachingService)
+        {
+            _globalMapService = globalMapService;
+            _cachingService = cachingService;
+        }
+
+        [Get("/api/v1/world/caravans")]
+        public async Task GetCaravans(HttpListenerContext context)
+        {
+            await _cachingService.CacheAwareResponseAsync(
+                context,
+                "caravans",
+                () => Task.FromResult(_globalMapService.GetCaravans()),
+                expiration: TimeSpan.FromSeconds(3),
+                expirationType: CacheExpirationType.GameTick
+            );
+        }
+
+        [Get("/api/v1/world/settlements")]
+        public async Task GetSettlements(HttpListenerContext context)
+        {
+            await _cachingService.CacheAwareResponseAsync(
+                context,
+                "settlements",
+                () => Task.FromResult(_globalMapService.GetSettlements()),
+                expiration: TimeSpan.FromSeconds(10),
+                expirationType: CacheExpirationType.GameTick
+            );
+        }
+
+        [Get("/api/v1/world/sites")]
+        public async Task GetSites(HttpListenerContext context)
+        {
+            await _cachingService.CacheAwareResponseAsync(
+                context,
+                "sites",
+                () => Task.FromResult(_globalMapService.GetSites()),
+                expiration: TimeSpan.FromSeconds(5),
+                expirationType: CacheExpirationType.GameTick
+            );
+        }
+
+        [Get("/api/v1/world/tile")]
+        public async Task GetTile(HttpListenerContext context)
+        {
+            var tileId = RequestParser.GetIntParameter(context, "id");
+            await _cachingService.CacheAwareResponseAsync(
+                context,
+                $"tile_{tileId}",
+                () => Task.FromResult(_globalMapService.GetTile(tileId)),
+                expiration: TimeSpan.FromSeconds(120),
+                expirationType: CacheExpirationType.Absolute
+            );
+        }
+    }
+}