TaskHub.Shared

API Versioning & Swagger

TaskHub.Shared provides a unified way to version your APIs and document them using Swagger (OpenAPI).

API Versioning

TaskHub uses URL-based versioning by default (e.g., /v1/tasks).

Configuration

"Versioning": {
  "DefaultVersion": "1.0",
  "AssumeDefaultVersionWhenUnspecified": true
}

Usage

Decorate your controllers with the [ApiVersion] and [Route] attributes.

[ApiVersion("1.0")]
[Route("v{version:apiVersion}/tasks")]
public class TasksController : ControllerBase { ... }

Swagger Integration

The TaskHub.Shared.Swagger module pre-configures Swagger UI to handle TaskHub’s specific patterns.

Configuration

"Swagger": {
  "Title": "TaskHub API",
  "Version": "v1",
  "IsSecurityEnabled": true
}

Features

• JWT Authorization: If IsSecurityEnabled is true, a “Authorize” button appears, allowing you to paste a JWT token.
• XML Documentation: Automatically includes comments from your code (if XML documentation is enabled in the .csproj).
• Versioning Support: Automatically detects and displays different API versions.

Registration

In your Program.cs:

builder.Services.AddAppVersioning(builder.Configuration.GetSection("Versioning").Bind);
builder.Services.AddAppSwagger(builder.Configuration.GetSection("Swagger").Bind);

In your app configuration:

app.UseSwagger();
app.UseAppSwaggerUI(builder.Configuration.GetSection("Swagger").Bind);

This site is open source. Improve this page.