Version 1.0

Author: drwatson1

ProjectTemplates/How to create new template.md

@@ -5,16 +5,16 @@ After making any changes do:
 1. Select Release configuration for a solution
 1. Select ReferenceProject in "Solution Explorer"  and click "Project/Export Template..." menu item from the VS main menu
 1. In the appeared dialog box select "Project template" option and "ReferenceProject" in the combobox below and click Next
-1. Set the value "ASP.Net WebAPI Application with OWIN" as a template name
+1. Set the value "ASP.Net Core RESTful Service" as a template name and the "Project template to create production-ready RESTful service based on ASP.Net Core. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features" as a description
 1. Clear checkbox "Automatically import the template into Visual Studio" if you don't want immediately import it and click Finish button
 1. Extract all files from the created zip-archive to any folder as you want. Typically, the file can be found in "C:\Users\<YOU>\Documents\Visual Studio 2017\My Exported Templates" folder
-1. Open ReferenceProject.csproj file in any text editor and find "DocumentationFile" tag
-1. Replace string "%24safeprojectname%24" to "$safeprojectname$" inside it and save the file
-1. Replace a file "MyTemplate.vstemplate" with the one from the project folder with the same name
-1. Add all files from the folder to zip-archive with a name "ASP.Net WebAPI Application with OWIN.zip"
-1. Copy this file to "ProjectTemplates\AspNet.WebApi\ReferenceProject\ReferenceProjectVSIX\ProjectTemplates\CSharp\Web" folder and replace an existing one
+1. Open a file "MyTemplate.vstemplate"
+1. Replace content of the tag `DefaultName` in the section `TemplateData` to "ASPNetCore.Service" (without quotation)
+1. Add tag `NumberOfParentCategoriesToRollUp` to the same section with value '1': `<NumberOfParentCategoriesToRollUp>1</NumberOfParentCategoriesToRollUp>`
+1. Add all files from the folder to zip-archive with a name "ASP.Net Core RESTful Service.zip". All added files must be in the root of the archive
+1. Copy this file to "ProjectTemplates\ReferenceProjectVSIX\ProjectTemplates\CSharp\.NET Core" folder and replace an existing one
 1. Go to VS, expand a ReferenceProjectVSIX project and double click on source.extension.vsixmanifest file
 1. Increase minor version number on the tab "Metadata" in the top right corner
-1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net WebAPI Application Project Template.vsix"
+1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net Core RESTful Service Template.vsix"
 
-That's all. "ASP.Net WebAPI Application Project Template.vsix" can be uploaded to VS Marketplace or installed in VS.
+That's all. "ASP.Net Core RESTful Service Template.vsix" can be uploaded to VS Marketplace or installed in VS.

ProjectTemplates/ReferenceProject/Configuration/AutoMapperProfiles/DefaultProfile.cs

@@ -2,6 +2,10 @@
 
 namespace ReferenceProject.Profiles
 {
+    /// <summary>
+    /// Default profile for AutoMapper
+    /// </summary>
+    /// <remarks>See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#automapper</remarks>
     public class DefaultProfile: Profile
     {
         public DefaultProfile()

ProjectTemplates/ReferenceProject/Configuration/AutofacModules/DefaultModule.cs

@@ -2,6 +2,12 @@
 
 namespace ReferenceProject.Modules
 {
+    /// <summary>
+    /// Default module for Autofac
+    /// </summary>
+    /// <remarks>
+    /// See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#dependency-injection
+    /// </remarks>
     public class DefaultModule: Module
     {
         protected override void Load(ContainerBuilder builder)

ProjectTemplates/ReferenceProject/Configuration/DependenciesConfig.cs

@@ -8,6 +8,12 @@ namespace ReferenceProject
 {
     public static class DependenciesConfig
     {
+        /// <summary>
+        /// Add Swagger middleware
+        /// </summary>
+        /// <remarks>
+        /// See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#documenting-api
+        /// </remarks>
         public static IServiceCollection AddSwagger(this IServiceCollection services)
         {
             // Register the Swagger generator, defining 1 or more Swagger documents

ProjectTemplates/ReferenceProject/Configuration/MiddlewareConfig.cs

@@ -4,6 +4,12 @@ namespace ReferenceProject
 {
     public static class MiddlewareConfig
     {
+        /// <summary>
+        /// Use swagger UI and endpoint
+        /// </summary>
+        /// <remarks>
+        /// See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#documenting-api
+        /// </remarks>
         public static IApplicationBuilder UseSwaggerWithOptions(this IApplicationBuilder app)
         {
             // Enable middleware to serve generated Swagger as a JSON endpoint.

ProjectTemplates/ReferenceProject/Filters/CacheControlFilter.cs

@@ -2,6 +2,10 @@
 
 namespace ReferenceProject.Filters
 {
+    /// <summary>
+    /// Filter to add header Cache-Control to responses
+    /// </summary>
+    /// <remarks>See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#cache-control</remarks>
     public class CacheControlFilter: IResultFilter
     {
         public void OnResultExecuted(ResultExecutedContext context)

ProjectTemplates/ReferenceProject/Filters/ValidateModelFilter.cs

@@ -3,6 +3,10 @@
 
 namespace ReferenceProject.Filters
 {
+    /// <summary>
+    /// Filter to check is a model valid
+    /// </summary>
+    /// <remarks>See: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#model-validation</remarks>
     public class ValidateModelFilter: IActionFilter
     {
         public void OnActionExecuted(ActionExecutedContext context)

ProjectTemplates/ReferenceProject/Middleware/ExceptionMiddleware.cs

@@ -18,6 +18,8 @@ namespace ReferenceProject.Middleware
     /// There is another way to do this - an exception filter.
     /// However, a middleware is a preferred way to achieve this according to the official documentation.
     /// To learn more see https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-2.1#exception-filters
+    /// 
+    /// See also: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#unhandled-exceptions-handling
     /// </remarks>
     public class ExceptionMiddleware
     {

ProjectTemplates/ReferenceProject/Middleware/OptionsVerbMiddleware.cs

@@ -3,9 +3,12 @@
 
 namespace ReferenceProject.Middleware
 {
-    // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
-    // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Preflighted_requests
-    // https://developer.mozilla.org/ru/docs/Web/HTTP/Methods/OPTIONS
+    /// <summary>
+    /// OPTIONS HTTP-method handler
+    /// </summary>
+    /// <remarks>
+    /// See:     https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#cross-origin-resource-sharing-cors-and-preflight-requests
+    /// </remarks>
     public class OptionsVerbMiddleware
     {
         RequestDelegate Next { get; }

ProjectTemplates/ReferenceProject/Program.cs

@@ -24,6 +24,7 @@ public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
 
                     /*
                      * You can use a global logger as this, but I don't recommend this way
+                     * More information: https://github.com/drwatson1/AspNet-Core-REST-Service/wiki#logging
                     Log.Logger = new LoggerConfiguration()
                         .ReadFrom.Configuration(context.Configuration)
                         .CreateLogger();