Add oas generation

Author: aimenux

oas/Api.json

@@ -0,0 +1,66 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "DummyWebApiDemo",
+    "version": "1"
+  },
+  "paths": {
+    "/api/v1/dummies/{dummyId}": {
+      "get": {
+        "tags": [
+          "Dummies"
+        ],
+        "parameters": [
+          {
+            "name": "dummyId",
+            "in": "path",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/api/v1/dummies": {
+      "post": {
+        "tags": [
+          "Dummies"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateDummyRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CreateDummyRequest": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  }
+}

oas/Api_v2.json

@@ -0,0 +1,98 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "DummyWebApiDemo",
+    "version": "2"
+  },
+  "paths": {
+    "/api/v2/dummies": {
+      "get": {
+        "tags": [
+          "Dummies"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      },
+      "post": {
+        "tags": [
+          "Dummies"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateDummyRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/api/v2/dummies/search": {
+      "get": {
+        "tags": [
+          "Dummies"
+        ],
+        "parameters": [
+          {
+            "name": "Keyword",
+            "in": "query",
+            "style": "form",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/api/v2/dummies/{dummyId}": {
+      "get": {
+        "tags": [
+          "Dummies"
+        ],
+        "parameters": [
+          {
+            "name": "dummyId",
+            "in": "path",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CreateDummyRequest": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  }
+}

src/Api/Api.csproj

@@ -4,6 +4,9 @@
     <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
+    <OpenApiDocumentsDirectory>$(SolutionDir)\oas</OpenApiDocumentsDirectory>
+    <OpenApiGenerateDocuments>true</OpenApiGenerateDocuments>
+    <OpenApiGenerateDocumentsOnBuild>true</OpenApiGenerateDocumentsOnBuild>
   </PropertyGroup>
 
   <ItemGroup>
@@ -14,6 +17,10 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.ApiDescription.Server" Version="8.0.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="Serilog.AspNetCore" Version="8.0.1" />
     <PackageReference Include="Serilog.Sinks.Console" Version="5.0.1" />
     <PackageReference Include="Serilog.Sinks.File" Version="5.0.0" />

src/Api/Extensions/SwaggerExtensions.cs

@@ -10,22 +10,12 @@ public static class SwaggerExtensions
 {
     public static void AddSwaggerDoc(this WebApplicationBuilder builder)
     {
-        if (builder.Environment.IsProduction())
-        {
-            return;
-        }
-        
         builder.Services.ConfigureOptions<ConfigureSwaggerOptions>();
         builder.Services.AddSwaggerGen();
     }
 
     public static void UseSwaggerDoc(this WebApplication app)
     {
-        if (app.Environment.IsProduction())
-        {
-            return;
-        }
-        
         app.UseSwagger();
         app.UseSwaggerUI(options =>
         {