docs: add Fly server to swagger (#40)

helldivers-2 · Apr 3, 2024 · b4d3cc1 · b4d3cc1
1 parent e5f5953
commit b4d3cc1
Show file tree

Hide file tree

Showing 3 changed files with 222 additions and 0 deletions.
diff --git a/src/Helldivers-2-API/OpenApi/HelldiversDocumentProcessor.cs b/src/Helldivers-2-API/OpenApi/HelldiversDocumentProcessor.cs
@@ -0,0 +1,40 @@
+#if DEBUG
+using NSwag;
+using NSwag.Generation.Processors;
+using NSwag.Generation.Processors.Contexts;
+
+namespace Helldivers.API.OpenApi;
+
+/// <summary>
+/// Handles processing of the OpenAPI specification of the Production Helldivers API.
+/// </summary>
+public class HelldiversDocumentProcessor : IDocumentProcessor
+{
+    private const string HelldiversFlyServer = "https://helldivers-2-dotnet.fly.dev/";
+    private const string LocalServer = "/";
+
+    /// <inheritdoc />
+    public void Process(DocumentProcessorContext context)
+    {
+        // First we make a copy of the Paths, since C# doesn't like it when collections are modified during iteration.
+        var paths = context.Document.Paths.ToList();
+        var server = new OpenApiServer
+        {
+            Description = "The dotnet helldivers server",
+            Url = HelldiversFlyServer
+        };
+        var local = new OpenApiServer
+        {
+            Description = "The development server",
+            Url = LocalServer
+        };
+
+        foreach (var (_, item) in paths)
+        {
+            item.Servers.Clear();
+            item.Servers.Add(server);
+            item.Servers.Add(local);
+        }
+    }
+}
+#endif
diff --git a/src/Helldivers-2-API/Program.cs b/src/Helldivers-2-API/Program.cs
@@ -107,6 +107,8 @@
                 schema => schema.Type = NJsonSchema.JsonObjectType.String
             )
         );
+
+        document.DocumentProcessors.Add(new Helldivers.API.OpenApi.HelldiversDocumentProcessor());
     });
     builder.Services.AddOpenApiDocument(document =>
     {

diff --git a/src/Helldivers-2-API/wwwroot/Helldivers-2-API.json b/src/Helldivers-2-API/wwwroot/Helldivers-2-API.json
@@ -8,6 +8,16 @@
   },
   "paths": {
     "/raw/api/WarSeason/current/WarID": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -29,6 +39,16 @@
       }
     },
     "/raw/api/WarSeason/801/Status": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -50,6 +70,16 @@
       }
     },
     "/raw/api/WarSeason/801/WarInfo": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -71,6 +101,16 @@
       }
     },
     "/raw/api/Stats/war/801/summary": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -92,6 +132,16 @@
       }
     },
     "/raw/api/NewsFeed/801": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -116,6 +166,16 @@
       }
     },
     "/raw/api/v2/Assignment/War/801": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "raw"
@@ -143,6 +203,16 @@
       }
     },
     "/api/v1/war": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -164,6 +234,16 @@
       }
     },
     "/api/v1/assignments": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -188,6 +268,16 @@
       }
     },
     "/api/v1/assignments/{index}": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -221,6 +311,16 @@
       }
     },
     "/api/v1/campaigns": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -245,6 +345,16 @@
       }
     },
     "/api/v1/campaigns/{index}": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -278,6 +388,16 @@
       }
     },
     "/api/v1/dispatches": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -302,6 +422,16 @@
       }
     },
     "/api/v1/dispatches/{index}": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -335,6 +465,16 @@
       }
     },
     "/api/v1/planets": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -359,6 +499,16 @@
       }
     },
     "/api/v1/planets/{index}": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -392,6 +542,16 @@
       }
     },
     "/api/v1/planet-events": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -416,6 +576,16 @@
       }
     },
     "/api/v1/steam": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
@@ -441,6 +611,16 @@
       }
     },
     "/api/v1/steam/{gid}": {
+      "servers": [
+        {
+          "url": "https://helldivers-2-dotnet.fly.dev/",
+          "description": "The dotnet helldivers server"
+        },
+        {
+          "url": "/",
+          "description": "The dotnet helldivers server"
+        }
+      ],
       "get": {
         "tags": [
           "v1"
-Original file line number
+Diff line change
@@ Expand Up / @@ -107,6 +107,8 @@ @@
                     schema => schema.Type = NJsonSchema.JsonObjectType.String
                 )
             );
+            document.DocumentProcessors.Add(new Helldivers.API.OpenApi.HelldiversDocumentProcessor());
         });
         builder.Services.AddOpenApiDocument(document =>
         {
@@ Expand Down @@