RazorDocs Search
Section API Reference
API Reference Component: Scalar Audience: developer

Scalar

Type

AppSurfaceWebScalarModule

Source

A web module that integrates Scalar API reference documentation into the application.

Method

ConfigureServices

void ConfigureServices(StartupContext context, IServiceCollection services) Source

Configures services needed for Scalar; currently no implementation is required.

Parameters

  • contextThe startup context.
  • servicesThe service collection.
Method

RegisterDependentModules

void RegisterDependentModules(ModuleDependencyBuilder builder) Source

Registers dependencies for this module, specifically AppSurfaceWebOpenApiModule.

Parameters

  • builderThe module dependency builder.
Method

ConfigureEndpoints

void ConfigureEndpoints(StartupContext context, IEndpointRouteBuilder endpoints) Source

Maps the Scalar API reference endpoint.

Parameters

  • contextThe startup context.
  • endpointsThe endpoint route builder.
Method

ConfigureHostBeforeServices

void ConfigureHostBeforeServices(StartupContext context, IHostBuilder builder) Source

Executes pre-service host configuration; currently no implementation is required.

Parameters

  • contextThe startup context.
  • builderThe host builder.
Method

ConfigureHostAfterServices

void ConfigureHostAfterServices(StartupContext context, IHostBuilder builder) Source

Executes post-service host configuration; currently no implementation is required.

Parameters

  • contextThe startup context.
  • builderThe host builder.
Method

ConfigureWebApplication

void ConfigureWebApplication(StartupContext context, IApplicationBuilder app) Source

Configures the web application pipeline; currently no implementation is required.

Parameters

  • contextThe startup context.
  • appThe application builder.