Adding Custom ODS / API Features

The Ed-Fi ODS / API comes with a set of configurable features that can be enabled or disabled using configuration settings in deployed API. Additional custom features could be implemented by following the steps outlined here:

Step 1. Create a Service

namespace EdFi.Ods.Services
{
    public class TestService : ITestService
    {
		public void DoSomething() { }
    }
}

Step 2. Add a New Autofac Module Class

2a. Inherit from ConditionalModule in EdFi.Ods.Common.

2b. Override IsSelected method

2c. Override ApplyConfigurationSpecificRegistrations method

using Autofac;
using EdFi.Common.Configuration;
using EdFi.Ods.Common.Configuration;
using EdFi.Ods.Common.Container;
using EdFi.Ods.TestService;

namespace EdFi.Ods.Features.Container.Modules
{
    public class TestModule : ConditionalModule 
    {
		public TestModule(ApiSettings apiSettings) : base(apiSettings, nameof(TestModule)) { }

	    public override bool IsSelected() => IsFeatureEnabled(ApiFeature.TestService);

        public override void ApplyConfigurationSpecificRegistrations(ContainerBuilder builder)
        {
			// TODO add components to register.
        }
    }
}

Step 3. Add Configuration Setting in appsettings.json in EdFi.Ods.WebApi Project

{
  ...
  "Features": [
      {
        "Name": "TestService",
        "IsEnabled": true
      }
      ...
  ]
  ...
}

Ed-Fi ODS / API for Suite 3 v7.0

Adding Custom ODS / API Features

Analytics

Step 1. Create a Service

Step 2. Add a New Autofac Module Class

Step 3. Add Configuration Setting in appsettings.json in EdFi.Ods.WebApi Project

Related content