NP.Lti13Platform 1.0.0-preview001

NP.Lti13Platform

NP.Lti13Platform is a .NET 8 project that provides an implementation of an LTI 1.3 platform. This project is a wrapper for the other LTI 1.3 projects. For specific information regarding any of the specific specs, please see their respective projects.

Features

• LTI 1.3 Core (Launch)
• Deep Linking
• Assignment and Grade Services
• Name and Role Provisioning Services

Getting Started

1. Add the nuget package to your project:

2. Add an implementation of the IDataService interface:

public class DataService: IDataService
{
    ...
}

3. Add the required services (most configurations are optional, the required configurations are shown):
   *For information regarding configurations, please see the individual projects.

builder.Services
    .AddLti13PlatformWithDefaults(x => { x.Issuer = "https://<site>.com"; })
    .AddDataService<DataService>();

4. Setup the routing for the LTI 1.3 platform endpoints:

app.UseLti13Platform();

IDataService

There is no default IDataService implementation to allow each project to store the data how they see fit.

The IDataService interface is a combination of all data services required for all the specs of the LTI 1.3 platform. Each service can be individually overridden instead of implementing the entire data service in a single service.

builder.Services
+    .AddLti13PlatformWithDefaults(x => { x.Issuer = "https://<site>.com"; });
-    .AddLti13PlatformWithDefaults(x => { x.Issuer = "https://<site>.com"; })
-    .AddDataService<DataService>();

+ builder.Services.AddTransient<ICoreDataService, CustomCoreDataService>();
+ builder.Services.AddTransient<IDeepLinkingDataService, CustomDeepLinkingDataService>();
+ builder.Services.AddTransient<INameRoleProvisioningDataService, CustomNameRoleProvisioningDataService>();
+ builder.Services.AddTransient<IAssignmentGradeDataService, CustomAssignmentGradeDataService>();

All of the internal services are transient and therefore the data services may be added at any scope (Transient, Scoped, Singleton).

Defaults

Many of the specs have default implementations that use a static configuration on startup. The defaults are set in the AddLti13PlatformWithDefaults method. If you can't configure the services at startup you can use the non-default extension method and add your own implementation of the services.

builder.Services
-    .AddLti13PlatformWithDefaults(x => { x.Issuer = "https://<site>.com"; })
+    .AddLti13Platform()
    .AddDataService<DataService>();

+ builder.Services.AddTransient<ITokenService, TokenService>();
+ builder.Services.AddTransient<IPlatformService, PlatformService>();
+ builder.Services.AddTransient<IDeepLinkingService, TokenService>();
+ builder.Services.AddTransient<IAssignmentGradeService, AssignmentGradeService>();
+ builder.Services.AddTransient<INameRoleProvisioningService, NameRoleProvisioningService>();