Merge pull request #29 from dimmik/swagger

Swagger
dimmik · Oct 19, 2019 · 5b2047e · 5b2047e
2 parents cc59e20 + 7c1d6e7
commit 5b2047e
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 13 deletions.
diff --git a/TourCalcWebApp/Controllers/AuthController.cs b/TourCalcWebApp/Controllers/AuthController.cs
@@ -15,8 +15,6 @@
 using TourCalcWebApp.Auth;
 using TourCalcWebApp.Exceptions;
 
-// For more information on enabling MVC for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860
-
 namespace TourCalcWebApp.Controllers
 {
     [Route("api/[controller]")]
@@ -53,6 +51,7 @@ public string GenerateRandomKey(int lengthInBytes)
         /// </summary>
         /// <param name="scope">Should be 'code' or 'admin'</param>
         /// <param name="key">code or admin key</param>
+        /// <param name="signerKey">ECDSA crypto service</param>
         /// <returns>JWT Token</returns>
         [HttpGet("token/{scope}/{key}")]
         public string GetToken(string scope, string key, [FromServices] IECDsaCryptoKey signerKey)
@@ -106,7 +105,7 @@ private AuthData Authorize(string scope, string accessCode)
                     auth.IsMaster = true;
                 } else
                 {
-                    throw HttpException.NotAuthenticated($"Wrong Master Key. Should be '{Guid.NewGuid()}'");
+                    throw HttpException.NotAuthenticated($"Wrong Master Key");
                 }
             }
             /*else if (scope == "user")

diff --git a/TourCalcWebApp/Exceptions/HttpException.cs b/TourCalcWebApp/Exceptions/HttpException.cs
@@ -1,8 +1,5 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Net;
-using System.Threading.Tasks;
 
 namespace TourCalcWebApp.Exceptions
 {
@@ -23,34 +20,37 @@ public static HttpException NotAuthenticated(string msg)
             return new HttpException(401, msg);
         }
 
+
+
+
         public HttpException(int httpStatusCode)
         {
-            this.StatusCode = httpStatusCode;
+            StatusCode = httpStatusCode;
         }
 
         public HttpException(HttpStatusCode httpStatusCode)
         {
-            this.StatusCode = (int)httpStatusCode;
+            StatusCode = (int)httpStatusCode;
         }
 
-        private HttpException(int httpStatusCode, string message) : base(message)
+        public HttpException(int httpStatusCode, string message) : base(message)
         {
-            this.StatusCode = httpStatusCode;
+            StatusCode = httpStatusCode;
         }
 
         public HttpException(HttpStatusCode httpStatusCode, string message) : base(message)
         {
-            this.StatusCode = (int)httpStatusCode;
+            StatusCode = (int)httpStatusCode;
         }
 
         public HttpException(int httpStatusCode, string message, Exception inner) : base(message, inner)
         {
-            this.StatusCode = httpStatusCode;
+            StatusCode = httpStatusCode;
         }
 
         public HttpException(HttpStatusCode httpStatusCode, string message, Exception inner) : base(message, inner)
         {
-            this.StatusCode = (int)httpStatusCode;
+            StatusCode = (int)httpStatusCode;
         }
 
         public int StatusCode { get; }

diff --git a/TourCalcWebApp/Startup.cs b/TourCalcWebApp/Startup.cs
@@ -16,6 +16,11 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.Swagger;
 using TourCalcWebApp.Exceptions;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using Microsoft.AspNetCore.Authorization;
+using System.Collections.Generic;
+using System.Linq;
+using Swashbuckle.AspNetCore.Filters;
 
 namespace TourCalcWebApp
 {
@@ -41,6 +46,18 @@ public void ConfigureServices(IServiceCollection services)
             services.AddSwaggerGen(c =>
             {
                 c.SwaggerDoc("v1", new Info { Title = "Tourcalc API", Version = "v1" });
+                // https://stackoverflow.com/questions/43447688/setting-up-swagger-asp-net-core-using-the-authorization-headers-bearer
+                c.AddSecurityDefinition("Bearer",
+                        new ApiKeyScheme
+                        {
+                            In = "header",
+                            Description = "Please enter into field the word 'Bearer' following by space and JWT",
+                            Name = "Authorization",
+                            Type = "apiKey"
+                        });
+                c.AddSecurityRequirement(new Dictionary<string, IEnumerable<string>> {
+                    { "Bearer", Enumerable.Empty<string>() },
+                });
                 // Set the comments path for the Swagger JSON and UI.
                 var xmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
                 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);

diff --git a/TourCalcWebApp/TourCalcWebApp.csproj b/TourCalcWebApp/TourCalcWebApp.csproj
@@ -34,6 +34,7 @@
     <PackageReference Include="Microsoft.OpenApi" Version="1.1.4" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="2.2.3" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="4.0.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="4.5.5" />
   </ItemGroup>
 
   <ItemGroup>