Added Swagger

Author: rxtur

plugins/Common/Widgets/Categories.cs

@@ -41,6 +41,7 @@ public async Task<IViewComponentResult> InvokeAsync(string theme, string widget)
         }
     }
 
+    [ApiExplorerSettings(IgnoreApi = true)]
     [Route("widgets/api/categories")]
     public class CategoriesController : Controller
     {

plugins/Common/Widgets/HtmlBlock.cs

@@ -37,6 +37,7 @@ public IViewComponentResult Invoke(string theme, string widget)
         }
     }
 
+    [ApiExplorerSettings(IgnoreApi = true)]
     [Route("widgets/api/htmlblock")]
     public class HtmlBlockController : Controller
     {

plugins/Common/Widgets/Newsletter.cs

@@ -33,17 +33,18 @@ public IViewComponentResult Invoke(string theme, string widget)
         }
     }
 
+    [ApiExplorerSettings(IgnoreApi = true)]
     [Route("widgets/newsletter")]
     public class NewsletterController : Controller
     {
-        IDataService _db;
+        readonly IDataService _db;
 
         public NewsletterController(IDataService db)
         {
             _db = db;
         }
 
-        [Route("load")]
+        [HttpGet("load")]
         public async Task<NewsletterModel> Load(int page = 1)
         {
             var pager = new Pager(page);

plugins/Common/Widgets/PostList.cs

@@ -66,6 +66,7 @@ public IViewComponentResult Invoke(string theme, string widget)
         }
     }
 
+    [ApiExplorerSettings(IgnoreApi = true)]
     [Route("widgets/api/postlist")]
     public class PostListController : Controller
     {

src/App/App.csproj

@@ -12,6 +12,7 @@
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="2.2.1" PrivateAssets="All" />
     <PackageReference Include="Serilog.Extensions.Logging" Version="2.0.2" />
     <PackageReference Include="Serilog.Sinks.RollingFile" Version="3.3.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc2" />
   </ItemGroup>
 
   <ItemGroup>

src/App/Controllers/AdminController.cs

@@ -8,6 +8,7 @@
 namespace App.Controllers
 {
     [Authorize]
+    [ApiExplorerSettings(IgnoreApi = true)]
     public class AdminController : Controller
     {
         IDataService _db;

src/App/Controllers/BlogController.cs

@@ -13,6 +13,7 @@
 
 namespace App.Controllers
 {
+    [ApiExplorerSettings(IgnoreApi = true)]
     public class BlogController : Controller
     {
         IDataService _db;
@@ -64,7 +65,7 @@ public async Task<IActionResult> Index(int page = 1, string term = "")
             return View(string.Format(_listView, blog.Theme), model);
         }
 
-        [Route("posts/{slug}")]
+        [HttpGet("posts/{slug}")]
         public async Task<IActionResult> Single(string slug)
         {
             try
@@ -88,7 +89,7 @@ public async Task<IActionResult> Single(string slug)
 
         }
 
-        [Route("authors/{name}")]
+        [HttpGet("authors/{name}")]
         public async Task<IActionResult> Authors(string name, int page = 1)
         {
             var blog = await _db.CustomFields.GetBlogSettings();
@@ -114,7 +115,7 @@ public async Task<IActionResult> Authors(string name, int page = 1)
             return View(string.Format(_listView, model.Blog.Theme), model);
         }
 
-        [Route("categories/{name}")]
+        [HttpGet("categories/{name}")]
         public async Task<IActionResult> Categories(string name, int page = 1)
         {
             var blog = await _db.CustomFields.GetBlogSettings();
@@ -139,7 +140,7 @@ public async Task<IActionResult> Categories(string name, int page = 1)
             return View(string.Format(_listView, model.Blog.Theme), model);
         }
 
-        [Route("feed/{type}")]
+        [HttpGet("feed/{type}")]
         public async Task Rss(string type)
         {
             Response.ContentType = "application/xml";
@@ -163,7 +164,7 @@ public async Task Rss(string type)
             }
         }
 
-        [Route("error/{code:int}")]
+        [HttpGet("error/{code:int}")]
         public async Task<IActionResult> Error(int code)
         {
             var model = new PostModel();

src/App/Startup.cs

@@ -102,6 +102,15 @@ public void ConfigureServices(IServiceCollection services)
             .AddApplicationPart(typeof(Core.Api.AuthorsController).GetTypeInfo().Assembly).AddControllersAsServices()
             .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
 
+            services.AddSwaggerGen(setupAction => {
+                setupAction.SwaggerDoc("spec",
+                    new Microsoft.OpenApi.Models.OpenApiInfo()
+                    {
+                        Title = "Blogifier API",
+                        Version = "1"
+                    });
+            });
+
             services.AddAppServices();
         }
 
@@ -117,6 +126,15 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env)
             app.UseStaticFiles();
             app.UseRequestLocalization();
 
+            app.UseSwagger();
+            app.UseSwaggerUI(setupAction =>
+            {
+                setupAction.SwaggerEndpoint(
+                    "/swagger/spec/swagger.json",
+                    "Blogifier API"
+                );
+            });
+
             AppSettings.WebRootPath = env.WebRootPath;
             AppSettings.ContentRootPath = env.ContentRootPath;
 

src/Core/Api/PostsController.cs

@@ -21,6 +21,7 @@ public PostsController(IDataService data)
             _data = data;
         }
 
+        [HttpGet]
         public async Task<ActionResult<PageListModel>> Get([FromQuery]string term = "", [FromQuery]string status = "", [FromQuery]int page = 1)
         {
             try

src/Core/Api/SettingsController.cs

@@ -27,7 +27,7 @@ public SettingsController(IDataService data, IOptions<RequestLocalizationOptions
             _options = options;
         }
 
-        [HttpGet("{cultures}")]
+        [HttpGet("cultures")]
         public async Task<ActionResult<List<SelectListItem>>> GetCultures()
         {
             try