Merge pull request danielgerlag#290 from hieuxlu/master

chore(sample): Improve WebApiSample, adding SwaggerUI, fix invalid cast from JObject

Author: danielgerlag

src/samples/WebApiSample/WebApiSample/Controllers/EventsController.cs

@@ -5,6 +5,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json.Linq;
+using WebApiSample.Workflows;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;
 
@@ -22,9 +23,9 @@ public EventsController(IWorkflowController workflowService)
         }
 
         [HttpPost("{eventName}/{eventKey}")]
-        public async Task<IActionResult> Post(string eventName, string eventKey, [FromBody]object eventData)
+        public async Task<IActionResult> Post(string eventName, string eventKey, [FromBody]MyDataClass eventData)
         {
-            await _workflowService.PublishEvent(eventName, eventKey, eventData);
+            await _workflowService.PublishEvent(eventName, eventKey, eventData.Value1);
             return Ok();
         }
 

src/samples/WebApiSample/WebApiSample/Properties/launchSettings.json

@@ -12,15 +12,15 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
-      "launchUrl": "api/values",
+      "launchUrl": "swagger",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
     "WebApiSample": {
       "commandName": "Project",
       "launchBrowser": true,
-      "launchUrl": "api/values",
+      "launchUrl": "swagger",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
@@ -29,7 +29,7 @@
     "Docker": {
       "commandName": "Docker",
       "launchBrowser": true,
-      "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/api/values"
+      "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/swagger"
     }
   }
 }

src/samples/WebApiSample/WebApiSample/Startup.cs

@@ -10,6 +10,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Nest;
+using Swashbuckle.AspNetCore.Swagger;
 using WebApiSample.Workflows;
 using WorkflowCore.Interface;
 
@@ -27,6 +28,13 @@ public Startup(IConfiguration configuration)
         public void ConfigureServices(IServiceCollection services)
         {
             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
+
+            // Register the Swagger generator, defining 1 or more Swagger documents
+            services.AddSwaggerGen(c =>
+            {
+                c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
+            });
+
             services.AddWorkflow(cfg =>
             {
                 cfg.UseMongoDB(@"mongodb://mongo:27017", "workflow");
@@ -41,6 +49,16 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env)
                 app.UseDeveloperExceptionPage();
             }
 
+            // Enable middleware to serve generated Swagger as a JSON endpoint.
+            app.UseSwagger();
+
+            // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), 
+            // specifying the Swagger JSON endpoint.
+            app.UseSwaggerUI(c =>
+            {
+                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
+            });
+
             app.UseMvc();
 
             var host = app.ApplicationServices.GetService<IWorkflowHost>();

src/samples/WebApiSample/WebApiSample/WebApiSample.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.1</TargetFramework>
@@ -16,6 +16,7 @@
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.0.2105168" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="2.1.1" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="4.0.1" />
     <PackageReference Include="WorkflowCore" Version="1.8.0" />
     <PackageReference Include="WorkflowCore.Persistence.MongoDB" Version="1.7.0" />
     <PackageReference Include="WorkflowCore.Providers.Elasticsearch" Version="1.8.0" />