Stardust.Interstellar.Rest.Service.AspNetCore 5.7.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Stardust.Interstellar.Rest.Service.AspNetCore --version 5.7.0
                    


                    

                
NuGet\Install-Package Stardust.Interstellar.Rest.Service.AspNetCore -Version 5.7.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Stardust.Interstellar.Rest.Service.AspNetCore" Version="5.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Stardust.Interstellar.Rest.Service.AspNetCore" Version="5.7.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Stardust.Interstellar.Rest.Service.AspNetCore" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Stardust.Interstellar.Rest.Service.AspNetCore --version 5.7.0
                    


                    

                
#r "nuget: Stardust.Interstellar.Rest.Service.AspNetCore, 5.7.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Stardust.Interstellar.Rest.Service.AspNetCore@5.7.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Stardust.Interstellar.Rest.Service.AspNetCore&version=5.7.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Stardust.Interstellar.Rest.Service.AspNetCore&version=5.7.0
                    


                            Install as a Cake Tool

Stardust.Interstellar.Rest.Service.AspNetCore

Define once. Generate everywhere.
Generate ASP.NET Core controllers and endpoints from decorated interfaces.

NuGet

What is Stardust.Rest?

Stardust.Rest lets you define your REST API as a C# interfaceβ€”then automatically generates both client proxies and server controllers. No more handwriting HttpClient boilerplate or scaffolding controllers.

[Api("api/users")]
public interface IUserService
{
    [Get("{id}")]
    Task<User> GetAsync([InPath] string id);

    [Post]
    Task<User> CreateAsync([InBody] User user);
}

That's it. Share this interface between your client and server projects. The ecosystem handles the rest.

Ecosystem Packages

Package What it does
Annotations Define your API contract
Client Generate HTTP clients from interfaces
Server Generate ASP.NET Core controllers from interfaces ← you are here

Why use it?

  • 🎯 Contract-first β€” One interface = perfect client/server alignment
  • ⚑ Zero boilerplate β€” No manual HTTP code or controller scaffolding
  • πŸ›‘οΈ Built-in resilience β€” Circuit breakers, retries, error handling
  • πŸ”Œ Extensible β€” Custom auth, headers, serialization, error handlers

Installation

dotnet add package Stardust.Interstellar.Rest.Service.AspNetCore

Quick Start

1. Define your interface

using Stardust.Interstellar.Rest.Annotations;

[Api("api/users")]
public interface IUserService
{
    [Get("{id}")]
    Task<User> GetUserAsync([InPath] string id);

    [Get]
    Task<IEnumerable<User>> GetAllAsync();

    [Post]
    Task<User> CreateAsync([InBody] User user);
}

2. Implement the service

public class UserService : IUserService
{
    private readonly IUserRepository _repo;
    public UserService(IUserRepository repo) => _repo = repo;

    public Task<User> GetUserAsync(string id) => _repo.GetByIdAsync(id);
    public Task<IEnumerable<User>> GetAllAsync() => _repo.GetAllAsync();
    public Task<User> CreateAsync(User user) => _repo.CreateAsync(user);
}

3. Register as controller

services.AddInterstellar();

services.AddMvc()
    .AddAsController<IUserService, UserService>()
    .UseInterstellar();  // Don't forget this!

4. Map routes

app.UseRouting();
app.UseEndpoints(endpoints => endpoints.MapControllers());

Registration Options

MVC Controllers

services.AddMvc()
    // With implementation type
    .AddAsController<IUserService, UserService>()
    // Or if already in DI
    .AddAsController<IProductService>()
    // Or with factory
    .AddAsController<IOrderService>(sp => new OrderService(sp.GetRequiredService<IOrderRepo>()))
    // Always call UseInterstellar() at the end
    .UseInterstellar();

Minimal API Endpoints (.NET 6+)

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddInterstellar();
builder.Services.AddScoped<IUserService, UserService>();

var app = builder.Build();

app.UseRouting();
app.UseEndpoints(endpoints =>
{
    endpoints.AddAsEndpoints<IUserService>();
});

app.Run();

Proxy Controller

Forward requests to another service:

services.AddMvc()
    .AddProxyController<IExternalService>("https://api.external.com")
    .UseInterstellar();

Parameter Binding

Parameters are automatically bound with proper ASP.NET Core attributes:

[Get("search")]
Task<SearchResult> SearchAsync(
    [InQuery("q")] string searchQuery,           // [FromQuery(Name = "q")]
    [InQuery("page_size")] int pageSize,         // [FromQuery(Name = "page_size")]
    [InHeader("X-Api-Key")] string apiKey);      // [FromHeader(Name = "X-Api-Key")]

[Post]
Task<User> CreateAsync([InBody] User user);      // [FromBody]

[Get("users/{id}")]
Task<User> GetAsync([InPath] string id);         // [FromRoute]

Authorization

Interface-level

[Api("api/admin")]
[AuthorizeWrapper(Roles = "Admin")]
public interface IAdminService { }

Method-level

[Api("api/users")]
public interface IUserService
{
    [Get]
    Task<IEnumerable<User>> GetAllAsync();

    [Delete("{id}")]
    [AuthorizeWrapper(Policy = "CanDelete")]
    Task DeleteAsync([InPath] string id);
}

Response Status Codes

[Post]
[SuccessStatusCode(HttpStatusCode.Created)]
Task<User> CreateAsync([InBody] User user);

[Delete("{id}")]
[SuccessStatusCode(HttpStatusCode.NoContent)]
Task DeleteAsync([InPath] string id);

API Versioning

[Api("api/users")]
[Version("1.0")]
public interface IUserServiceV1 { }

[Api("api/users")]
[Version("2.0")]
public interface IUserServiceV2 { }

Configure with Microsoft.AspNetCore.Mvc.Versioning:

services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(1, 0);
    options.AssumeDefaultVersionWhenUnspecified = true;
});

services.AddMvc()
    .AddAsController<IUserServiceV1, UserServiceV1>()
    .AddAsController<IUserServiceV2, UserServiceV2>()
    .UseInterstellar();

OpenAPI / Swagger

Generated controllers work with Swashbuckle out of the box:

[Api("api/users")]
[ServiceDescription("User management", Tags = "Users")]
public interface IUserService
{
    [Get("{id}", "Get user by ID")]
    Task<User> GetAsync([InPath(Description = "Unique user ID")] string id);

    [Get("search", "Search users")]
    Task<List<User>> SearchAsync(
        [InQuery("q", Description = "Search query")] string query,
        [InQuery("page_size", Description = "Results per page")] int pageSize);
}

Endpoint Routing Policies (.NET 6+)

Apply custom policies to minimal API endpoints:

public class CachingPolicy : IEndpointRoutingPolicy
{
    public string PolicyName => "Caching";
    public void ApplyPolicyAsync(RouteHandlerBuilder builder) { /* ... */ }
    public Dictionary<string, string> GetResponseHeaders() 
        => new() { ["Cache-Control"] = "public, max-age=300" };
}

// Register
services.AddSingleton<IEndpointRoutingPolicy>(new CachingPolicy());

// Apply
[Api("api/items")]
[EndpointRoutingPolicy("SecurityHeaders")]  // All endpoints
public interface IItemService
{
    [Get]
    [EndpointRoutingPolicy("Caching")]      // This endpoint only
    Task<List<Item>> GetItemsAsync();
}

Service Initialization

Perform setup when the service is instantiated:

public class UserService : IUserService, IInitializableService
{
    public void Initialize(StateDictionary state, object[] parameters)
    {
        // Called before method execution
    }
}

Contract-First Architecture

Share interfaces between client and server:

MyApi.Contracts/           ← Shared library
β”œβ”€β”€ IUserService.cs
β”œβ”€β”€ IProductService.cs
└── Models/
    └── User.cs

MyApi.Server/              ← Uses this package
β”œβ”€β”€ References MyApi.Contracts
└── Implements services

MyApi.Client/              ← Uses Stardust.Interstellar.Rest
β”œβ”€β”€ References MyApi.Contracts
└── Consumes services via proxy

Configuration

// Debug mode - throws during generation
ServiceFactory.ThrowOnException = true;

// Disable version header
ServiceFactory.DisableStardustVersion();

Full Example

// Program.cs (.NET 6+)
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddInterstellar();
builder.Services.AddScoped<IUserService, UserService>();
builder.Services.AddScoped<IProductService, ProductService>();

builder.Services.AddMvc()
    .AddAsController<IUserService, UserService>()
    .UseInterstellar();

builder.Services.AddSwaggerGen();

var app = builder.Build();

app.UseRouting();
app.UseAuthorization();

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();
    endpoints.AddAsEndpoints<IProductService>();
});

app.UseSwagger();
app.UseSwaggerUI();

app.Run();

Target Frameworks

.NET Standard 2.0 | .NET Core 3.1 | .NET 5.0 | .NET 6.0 | .NET 7.0 | .NET 8.0

Dependencies

  • Stardust.Interstellar.Rest.Annotations
  • Stardust.Interstellar.Rest
  • Microsoft.AspNetCore.Mvc.Versioning

License

Apache-2.0

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Stardust.Interstellar.Rest.Service.AspNetCore:

Package Downloads
Stardust.Interstellar.Rest.Service

Deprecated, this is only for ease of migration Create webapi controllers based on decorated interfaces.
Veracity.Common.OAuth.AspNetCore

Authentication library for the veracity services sdk for aspnetcore

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
5.7.0 54 1/6/2026
5.6.1 4,391 5/3/2024
5.6.0 238 3/5/2024
5.5.4 26,115 8/24/2022
5.5.3 3,473 5/23/2022
5.5.2 739 5/21/2022
5.5.1 820 5/16/2022
5.5.0-rc2 864 9/24/2021
5.5.0-rc1 1,179 9/6/2021
5.0.1 45,348 4/6/2021
5.0.0 7,794 2/24/2021
5.0.0-rc1 602 2/16/2021
4.2.1 1,002 11/13/2020
4.2.0 3,809 2/10/2020
4.1.0 12,683 8/20/2019
4.0.1 906 8/7/2019
4.0.0 2,934 8/5/2019

Fixed version issue with Microsoft.AspNetCore.Mvc.Versioning