Merge pull request #1 from lreb/development

First version to work with basic api

Author: lreb

FacwareBase.API/AWSLambdaEntryEndpoint.cs

@@ -0,0 +1,42 @@
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Hosting;
+
+namespace FacwareBase.API
+{
+    public class LambdaEntryPoint :
+
+        // The base class must be set to match the AWS service invoking the Lambda function. If not Amazon.Lambda.AspNetCoreServer
+        // will fail to convert the incoming request correctly into a valid ASP.NET Core request.
+        //
+        // API Gateway REST API                         -> Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
+        // API Gateway HTTP API payload version 1.0     -> Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
+        // API Gateway HTTP API payload version 2.0     -> Amazon.Lambda.AspNetCoreServer.APIGatewayHttpApiV2ProxyFunction
+        // Application Load Balancer                    -> Amazon.Lambda.AspNetCoreServer.ApplicationLoadBalancerFunction
+        // 
+        // Note: When using the AWS::Serverless::Function resource with an event type of "HttpApi" then payload version 2.0
+        // will be the default and you must make Amazon.Lambda.AspNetCoreServer.APIGatewayHttpApiV2ProxyFunction the base class.
+        Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
+    {
+		/// <summary>
+		/// The builder has configuration, logging and Amazon API Gateway already configured. The startup class
+		/// needs to be configured in this method using the UseStartup() method.
+		/// </summary>
+		/// <param name="builder"></param>
+		protected override void Init(IWebHostBuilder builder)
+        {
+            builder
+                .UseStartup<Startup>();
+        }
+
+		/// <summary>
+        /// Use this override to customize the services registered with the IHostBuilder. 
+        /// 
+        /// It is recommended not to call ConfigureWebHostDefaults to configure the IWebHostBuilder inside this method.
+        /// Instead customize the IWebHostBuilder in the Init(IWebHostBuilder) overload.
+        /// </summary>
+        /// <param name="builder"></param>
+        protected override void Init(IHostBuilder builder)
+        {
+        }
+    }
+}

FacwareBase.API/Extensions/Cors/CorsExtension.cs

@@ -0,0 +1,36 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace FacwareBase.Api.Extensions.Cors
+{
+	/// <summary>
+	/// Extension to setup CORS configuration
+	/// </summary>
+	public static class CorsExtension
+	{
+		/// <summary>
+		/// Policy cors name
+		/// </summary>
+		public static readonly string QSSAllowSpecificOrigins = "QSSAllowSpecificOrigins";
+
+		/// <summary>
+		/// CORS configurations
+		/// </summary>
+		/// <param name="services">application service <see cref="IServiceCollection"/></param>
+		/// <param name="configuration">app settings configuration <see cref="IConfiguration"/></param>
+		public static void ConfigureCors(this IServiceCollection services, IConfiguration configuration)
+		{
+			services.AddCors(options =>
+			{
+				options.AddPolicy(QSSAllowSpecificOrigins,
+					builder =>
+					{
+						builder.WithOrigins(configuration.GetSection("Cors:AllowedOrigin").Get<string[]>())
+							.AllowAnyHeader()
+							.AllowAnyMethod()
+							.AllowCredentials();
+					});
+			});
+		}
+	}
+}

FacwareBase.API/Extensions/Database/DatabaseExtension.cs

@@ -0,0 +1,40 @@
+using System.Data;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
+// using QSS.DataAccess.DataContext;
+
+namespace FacwareBase.Api.Extensions
+{
+    /// <summary>
+    /// The Service Collection Extensions
+    /// </summary>
+    /// <seealso cref="IServiceCollection"/>
+    public static class ServiceCollectionExtensions
+    {
+        /// <summary>
+        /// Set up the Service SQL DB Context
+        /// </summary>
+        /// <param name="serviceCollection">The <see cref="IServiceCollection"/></param>
+        /// <param name="applicationConfigurationConnectionString">The data migration connection string</param>
+        public static void UseSqlServer(this IServiceCollection serviceCollection, string applicationConfigurationConnectionString)
+        {
+          // TODO: use your context
+          //serviceCollection.AddDbContext<QSSContext>(o => o.UseSqlServer(applicationConfigurationConnectionString));
+        }
+
+        /// <summary>
+        /// Set up the Service PostgreSQL DB Context
+        /// </summary>
+        /// <param name="serviceCollection">The <see cref="IServiceCollection"/></param>
+        /// <param name="applicationConfigurationConnectionString">The data migration connection string</param>
+        public static void UsePostgreSqlServer(this IServiceCollection serviceCollection, string applicationConfigurationConnectionString)
+        {
+          // https://www.npgsql.org/efcore/api/Microsoft.Extensions.DependencyInjection.NpgsqlServiceCollectionExtensions.html#Microsoft_Extensions_DependencyInjection_NpgsqlServiceCollectionExtensions_AddEntityFrameworkNpgsql_IServiceCollection_
+          // https://www.npgsql.org/efcore/index.html#additional-configuration-for-aspnet-core-applications
+
+          // TODO: use your context
+          //serviceCollection.AddDbContext<QSSContext>(options => options.UseNpgsql(applicationConfigurationConnectionString));
+        }
+
+    }
+}

FacwareBase.API/Extensions/Environment/HostingEnvironmentExtension.cs

@@ -0,0 +1,40 @@
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Hosting;
+
+namespace FacwareBase.Api.Extensions.Environment
+{
+	/// <summary>
+	/// Custom environments extension
+	/// </summary>
+	public static class HostingEnvironmentExtension
+	{
+		/// <summary>
+		/// Quality assurance environment
+		/// </summary>
+		private const string QualityAssurance = "QualityAssurance";
+		/// <summary>
+		/// Local environment
+		/// </summary>
+		private const string Local = "Local";
+
+		/// <summary>
+		///  Checks if the current host environment name is quality assurance.
+		/// </summary>
+		/// <param name="hostingEnvironment">An instance of <see cref="IWebHostEnvironment"/>.</param>
+		/// <returns>True if the environment name is quality assurance.</returns>
+		public static bool IsQA(this IWebHostEnvironment hostingEnvironment)
+		{
+			return hostingEnvironment.IsEnvironment(QualityAssurance);
+		}
+
+		/// <summary>
+		///  Checks if the current host environment name is Local.
+		/// </summary>
+		/// <param name="hostingEnvironment">An instance of <see cref="IWebHostEnvironment"/>.</param>
+		/// <returns>True if the environment name is local</returns>
+		public static bool IsLocal(this IWebHostEnvironment hostingEnvironment)
+		{
+			return hostingEnvironment.IsEnvironment(Local);
+		}
+    }
+}

FacwareBase.API/Extensions/HealthCheck/CustomHealthCheck.cs

@@ -0,0 +1,42 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace FacwareBase.Api.Extensions.HealthCheck
+{
+	/// <summary>
+	/// Custom health check
+	/// </summary>
+	public class CustomHealthCheckExtension: IHealthCheck
+	{
+		/// <summary>
+		/// App settings data DI
+		/// </summary>
+		private readonly IConfiguration _config;
+
+		public CustomHealthCheckExtension(IConfiguration config)
+		{
+			_config = config;
+		}
+
+		/// <summary>
+		/// custom health check 
+		/// </summary>
+		/// <param name="context">Health check context <see cref="HealthCheckContext"/></param>
+		/// <param name="cancellationToken">cancellation token <see cref="CancellationToken"/></param>
+		/// <returns></returns>
+		public Task<HealthCheckResult> CheckHealthAsync(
+			HealthCheckContext context,
+			CancellationToken cancellationToken = default(CancellationToken))
+		{
+			Dictionary<string, object> data = new Dictionary<string, object>();
+			data["environment"] = _config["HealthChecks:Environment"];
+			data["corsAllowedOrigin"] = _config.GetSection("Cors:AllowedOrigin").Get<string[]>();
+			// data["connection"] = _config["ConnectionStrings:ApplicationConfigurationConnectionString"];
+			return Task.FromResult(
+				HealthCheckResult.Healthy("Test health check data", data));
+		}
+    }
+}

FacwareBase.API/Extensions/Swagger/SwaggerExtension.cs

@@ -0,0 +1,59 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using System;
+using System.IO;
+using System.Reflection;
+using Microsoft.AspNetCore.Builder;
+
+namespace FacwareBase.Api.Extensions.Swagger
+{
+	/// <summary>
+	/// Swagger extension
+	/// </summary>
+	public static class SwaggerExtension
+	{
+		#region Swagger Configuration
+		/// <summary>
+		/// Method to configure the Swagger Services within the Application services interface
+		/// </summary>
+		/// <param name="services">The Service Collection <see cref="IServiceCollection"/></param>
+		/// <param name="config">The Service Collection <see cref="IConfiguration"/></param>
+		public static void ConfigureSwaggerExtension(this IServiceCollection services, IConfiguration config)
+		{
+			services.AddSwaggerGen(c =>
+			{
+				c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
+				{
+					Title = config["SwaggerConfiguration:Title"], 
+					Version = config["SwaggerConfiguration:Version"],
+					Description = config["SwaggerConfiguration:Description"]
+				});
+
+				// Set the comments path for the Swagger JSON and UI.
+				var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+				var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+
+				c.IncludeXmlComments(xmlPath);
+			});
+		}
+		#endregion
+
+		/// <summary>
+		/// Enable Swagger pipeline
+		/// </summary>
+		/// <param name="app">application configuration <see cref="IApplicationBuilder"/></param>
+		/// <param name="config">application settings <see cref="IConfiguration"/></param>
+		public static void EnableSwaggerPipeline(this IApplicationBuilder app, IConfiguration config)
+		{
+			app.UseSwagger();
+			app.UseSwaggerUI(option =>
+			{
+				option.SwaggerEndpoint(
+					config["SwaggerConfiguration:SwaggerJSONEndpoints"], 
+					$"{config["SwaggerConfiguration:Title"]} {config["SwaggerConfiguration:Version"]}");
+				// To serve the Swagger UI at the apps root
+				option.RoutePrefix = string.Empty;
+			});
+		}
+	}
+}

FacwareBase.API/FacwareBase.API.csproj

@@ -2,7 +2,23 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Amazon.Lambda.AspNetCoreServer" Version="5.1.4" />
+    <PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="3.1.1" />
+    <PackageReference Include="EntityFramework6.Npgsql" Version="6.4.1" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="3.1.8" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.8">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="3.1.4" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.5.0" />
+  </ItemGroup>
+
 
 </Project>

FacwareBase.API/Helpers/Domain/ConectionString.cs

@@ -0,0 +1,7 @@
+namespace FacwareBase.API.Helpers.Domain
+{
+  public class ConnectionString
+  {
+    public string ApplicationConfigurationConnectionString { get; set; }    
+  }    
+}