API Setup

To install and successfully use this nuget package, please do the following:

1. Create a .net core 3.1 application (no other versions currently supported)
2. Install the nuget package Sphyrnidae.Common - eg. Install-Package Sphyrnidae.Common
3. Create a folder in your project called "Settings" (or "Implementations" or "Overrides" or whatever makes sense)
4. Project-specific implementations (to be placed inside this folder):
   1. IApplicationSettings: see Application for more information. Call this class <project>ApplicationSettings
   2. IFeatureToggleSettings: see Feature Toggle for more information
   3. IUserPreferenceSettings: see User Preferences for more information
   4. IVariableSettings: see Variables for more information
   5. ILoggerConfiguration: see Logging Configurations for more information
5. Update the program.cs class to include environmental variables: CreateHostBuilder() => Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); }).ConfigureAppConfiguration((hostingContext, config) => { config.AddEnvironmentVariables(); });
6. Update your startup.cs class to:
   1. Inject IConfiguration into the constructor (save this reference off) - will call this "Config"
   2. Instantiate and save off a new instance of ServiceConfiguration - will call this "ServiceConfig"
   3. Register your project-specific implementations in ConfigureServices():
      1. IApplicationSettings
      2. IFeatureToggleSettings
      3. IUserPreferenceSettings
      4. IVariableSettings
      5. ILoggerConfiguration
   4. Last thing in ConfigureServices() should be the call to services.AddCommonServices() - note that it takes the ServiceConfiguration, as well as 3 other concrete instances:
      1. var app = new <project>ApplicationSettings()
      2. var env = new EnvironmentalSettings(Config)
      3. var http = new HttpClientSettings(null, env)
   5. In Configure(), replace the entire configuration/pipeline with a single call to: app.UseServices(ServiceConfig, sp);
      1. app: injected IApplicationBuilder
      2. ServiceConfig: The saved off ServiceConfiguration
      3. sp: injected IServiceProvider
7. In launchSettings.json, ensure the "launchUrl" is configured to be "swagger"
8. Configure Project Settings:
   1. Build => Suppress Warnings: 1701;1702;1591
   2. Build => Treat warnings as errors => Specific warnings: ;NU1605
   3. Build => Output => ENable XML documentations file: obj\Debug\netcoreapp3.1&lt;IApplication.Name> Api.xml

That's the basic setup. As you develop API's, be sure to thoroughly comment them with XML comments. As you look to use other pieces of functionality in this package, there may be additional configurations you'll need to make.