ServiceStack

https://docs.servicestack.net
Admin
ServiceStack is a code-first web services framework for building high-performance REST, SOAP, and...
Tokens:2,113,514
Snippets:17,027
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example install command for published app

Source: https://docs.servicestack.net/netcore-windows-desktop

Example of the PowerShell command using a real published app URL (files.sharpscript.net).

```bash
powershell Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://files.sharpscript.net/VueDesktop/install.ps1'))
```

--------------------------------

### Setup VB .NET Core Auth + File Uploads Example

Source: https://docs.servicestack.net/vbnet

Commands to create a VB.NET .NET Core project for the vb-auth example, which includes authentication and file uploads.

```bash
$ mkdir ProjectName && cd ProjectName
$ npx add-in init-vb
```

--------------------------------

### Convert from Vue script setup

Source: https://docs.servicestack.net/razor-press/vue-in-markdown

This is roughly equivalent to the previous example if coming from VitePress or other npm Vue project that uses Vue's compile-time syntactic <script setup>.

```html
<script setup>
import { onMounted } from "vue"
import { Authenticate } from "./dtos.ts"
import { useAuth, useClient } from '@servicestack/vue'
import { JsonApiClient } from "@servicestack/client"
import Responsive from "./autoquerygrid/Responsive.vue"
import CustomBooking from "./autoquerygrid/CustomBooking.vue"

onMounted(async () => {
    const client = useClient()
    const api = await client.api(new Authenticate({ 
        provider: 'credentials', userName:'admin@email.com', password:'p@55wOrd' }))
    if (api.succeeded) {
        const { signIn } = useAuth()
        signIn(api.response)
    }
})
</script>
```

--------------------------------

### Create a Web App from the project template

Source: https://docs.servicestack.net/netcore

Command to quickly get started by creating a Web App from the project template.

```bash
dotnet-new bare-app ProjectName
```

--------------------------------

### SimpleAppSettings usage example

Source: https://docs.servicestack.net/appsettings

Shows how to use SimpleAppSettings, a Dictionary-based provider that only requires ServiceStack.Common. Demonstrates GetString, Get with default, and GetList.

```csharp
AppSettings = new SimpleAppSettings(new Dictionary<string, string> {
    ["string"] = "value",
    ["EnableFeature.1"] = "true",
    ["AllowedUsers"] = "Tom,Mick,Harry",
}));

string value = AppSettings.GetString("string");
bool enableFeature1 = AppSettings.Get("EnableFeature.1", defaultValue:false);
bool enableFeature2 = AppSettings.Get("EnableFeature.2", defaultValue:false);
IList<string> allowedUsers = AppSettings.GetList("AllowedUsers");
```

--------------------------------

### Install the 'app' dotnet tool

Source: https://docs.servicestack.net/netcore-windows-desktop

Installs the 'app' dotnet tool globally. Use this command to get started with creating .NET Core Windows Desktop Apps.

```bash
dotnet tool install -g app
```

--------------------------------

### Launch Studio with connect parameter

Source: https://docs.servicestack.net/studio

Equivalent command-line to the app://studio?connect URL scheme, connecting to a local instance.

```bash
$ app open studio6 -connect https://localhost:5001
```

--------------------------------

### Find free TCP port with HostContext.FindFreeTcpPort

Source: https://docs.servicestack.net/releases/2016-summary

Use HostContext.FindFreeTcpPort to get the first free TCP port in a specified range, then start the AppHost on that port. The example shows starting from port 5000 to 6000.

```csharp
var port = HostContext.FindFreeTcpPort(startingFrom:5000, endingAt:6000);
new AppHost()
    .Init()
    .Start($"http://localhost:{port}/");
```

--------------------------------

### Configure.StartupTasks.*.cs naming convention examples

Source: https://docs.servicestack.net/startup-tasks

Example filenames following the Configure.StartupTasks.*.cs convention for organizing Startup Task registrations in root-level configuration files.

```text
Configure.StartupTasks.GeneratedDtos.cs
Configure.StartupTasks.GeneratedPdfs.cs
Configure.StartupTasks.SearchIndex.cs
Configure.StartupTasks.SeedContent.cs
```

--------------------------------

### Get installed extension names with InstalledExtensionNames

Source: https://docs.servicestack.net/chat/extensions

C# code to retrieve the list of actually loaded extensions after configuration. The comment shows an example result.

```csharp
var installed = feature.InstalledExtensionNames;   // ["app","agents","tools",...]
```

--------------------------------

### Install and start multiple Redis services with custom names and ports

Source: https://docs.servicestack.net/install-redis-windows

Installs and starts three separate Redis instances as services, each with a unique service name and port.

```bash
$ redis-server --service-install –service-name redisService1 –port 10001
$ redis-server --service-start –service-name redisService1
$ redis-server --service-install –service-name redisService2 –port 10002
$ redis-server --service-start –service-name redisService2
$ redis-server --service-install –service-name redisService3 –port 10003
$ redis-server --service-start –service-name redisService3
```

--------------------------------

### Run the hello example

Source: https://docs.servicestack.net/zig-add-servicestack-reference

Command to build and run the hello example that calls live test.servicestack.net services.

```bash
zig build example
```

--------------------------------

### Start the daemon with sudo start example

Source: https://docs.servicestack.net/servicestack-as-daemon-on-linux

Run this command to start the application as a daemon. After starting, the default service information is available at http://127.0.0.1:8080.

```bash
$ sudo start example
```

--------------------------------

### Start Redis server with service command

Source: https://docs.servicestack.net/install-redis-windows

Starts the Redis server after installation using the service command.

```bash
sudo service redis-server start
```

--------------------------------

### Example app.settings before publishing

Source: https://docs.servicestack.net/netcore-windows-desktop

Shows a sample app.settings file with debug, name, and CefConfig settings.

```text
debug true
name Spirals
CefConfig { width:1100, height:900 }
```

--------------------------------

### Run hello example for ServiceStack Go client

Source: https://docs.servicestack.net/go-add-servicestack-reference

Command to run the examples/hello command, a small runnable example calling live test.servicestack.net Services with typed APIs, batched Requests, structured validation errors, and authenticated Requests.

```bash
go run ./examples/hello
```

--------------------------------

### CSharpGenerator.InnerTypeFilter Example

Source: https://docs.servicestack.net/csharp-add-servicestack-reference

Injects common members for all types and interfaces. This example adds an Id property with a new GUID.

```csharp
CSharpGenerator.InnerTypeFilter = (sb, type) => {
    sb.AppendLine("public string Id { get; } = Guid.NewGuid().ToString();");
};
```

--------------------------------

### Download and run the BookingsCrud example

Source: https://docs.servicestack.net/autoquery/bookings-crud

Commands to download and run the BookingsCrud example repository using the x tool.

```bash
x download NetCoreApps/BookingsCrud
cd BookingsCrud\Acme
dotnet run
```

--------------------------------

### DictionarySettings usage example

Source: https://docs.servicestack.net/appsettings

Shows how to use DictionarySettings to read structured configuration into clean data structures. Demonstrates Get, Get with default, GetList, GetDictionary, and Get with a custom POCO.

```csharp
IAppSettings settings = new DictionarySettings(configMap);

string value = settings.Get("StringKey");

int value = settings.Get("IntKey", defaultValue:1);

List<string> values = settings.GetList("ListKey");

Dictionary<string,string> valuesMap = settings.GetDictionary("key");

MyConfig config = settings.Get("key", new MyConfig { Key = "default"});
```

--------------------------------

### Create main.py with insecure example

Source: https://docs.servicestack.net/grpc/python

Use npx add-in to create main.py with the insecure Python example.

```bash
$ npx add-in todoworld-python

```

--------------------------------

### Install blog Sharp App with `app install blog`

Source: https://docs.servicestack.net/netcore-windows-desktop

Run `app install blog` to download and extract the latest release of the blog app. The output shows the installation success message and how to run the app.

```bash
app install blog
```

```text
Installing blog...

Installation successful, run with:

cd blog && app

Shortcut: blog\Blog Web App
```

--------------------------------

### Launch Redis VM with vagrant up

Source: https://docs.servicestack.net/install-redis-windows

Changes to the extracted vagrant-redis directory and starts the Virtual Box VM, which automatically installs and starts the latest stable Redis.

```bash
$ cd c:\vagrant-redis
$ vagrant up
```

--------------------------------

### Create client directory with npx add-in

Source: https://docs.servicestack.net/grpc/go

Creates the client directory and adds the insecure Go example using npx add-in.

```bash
$ mkdir client
$ npx add-in todoworld-go -out client
```

--------------------------------

### Basic service handling GET requests

Source: https://docs.servicestack.net/api-design

A simple example showing a request DTO with a route and a service that handles GET requests by selecting contacts from the database.

```csharp
[Route("/contacts")]
public class GetContacts : IReturn<List<Contact>> { }

public class ContactsService : Service
{
    public object Get(GetContacts request) => Db.Select<Contact>();
}
```

--------------------------------

### Step 5: Migrate modular startup class to IHostingStartup

Source: https://docs.servicestack.net/modular-startup

Shows the before and after of migrating a modular startup class from implementing IConfigureAppHost (net5.0) to implementing IHostingStartup (net8.0). The new version uses builder.ConfigureServices and services.AddPlugin.

```csharp
// net5.0 modular startup
using ServiceStack;

namespace Chinook;

public class ConfigureAutoQuery : IConfigureAppHost
{
    public void Configure(IAppHost appHost)
    {
        appHost.Plugins.Add(new AutoQueryFeature {
            MaxLimit = 1000,
            IncludeTotal = true
        });
    }
}
```

```csharp
// net8.0 modular startup using IHostingStartup
using Microsoft.AspNetCore.Hosting;
using ServiceStack;

[assembly: HostingStartup(typeof(Chinook.ConfigureAutoQuery))]

namespace Chinook;

public class ConfigureAutoQuery : IHostingStartup
{
    public void Configure(IWebHostBuilder builder) => builder
        .ConfigureServices(services => {
            services.AddPlugin(new AutoQueryFeature {
                MaxLimit = 1000,
                IncludeTotal = true
            });
        });
}
```

--------------------------------

### Define BookingToolsExtension class with Install method

Source: https://docs.servicestack.net/chat/configuration

Example of a custom ChatExtension subclass with configurable properties (NamedConnection, DefaultTake, IncludeCancelled) and an Install override that logs the connection and registers a tool. The properties are read during Install, which runs after configuration is set.

```csharp
public class BookingToolsExtension() : ChatExtension("booking_tools")
{
    /// <summary>OrmLite connection bookings are read from</summary>
    public string? NamedConnection { get; set; }
    /// <summary>Rows returned when the Agent doesn't specify a limit</summary>
    public int DefaultTake { get; set; } = 25;
    /// <summary>Whether cancelled bookings are counted in summaries</summary>
    public bool IncludeCancelled { get; set; }

    public override void Install(ExtensionContext ctx)
    {
        if (NamedConnection != null)
            ctx.Log.LogInformation("Bookings using {Db}", NamedConnection);

        ctx.RegisterTool<BookingSummaryCommand>("bookings");
    }
}
```

--------------------------------

### Install dev dependencies for static analysis

Source: https://docs.servicestack.net/api-explorer

Install Vue and ServiceStack client libraries as dev dependencies to get TypeScript definitions for static analysis at dev time.

```bash
npm install -D vue
npm install -D @servicestack/client
npm install -D @servicestack/vue
```

--------------------------------

### Full setup steps for new ServiceStack project

Source: https://docs.servicestack.net/do-github-action-mix-deployment

Complete sequence to create a new GitHub repository, clone it, generate a ServiceStack project, add GitHub Action templates, and push the initial commit.

```bash
git clone git@github.com:<your user or org>/WebApp.git # Where "WebApp" is the name of your repository
cd WebApp
npx create-net web
npx add-in build release-ghr-vanilla
git add -A
git commit -m "Add new ServiceStack project with GitHub Action files"
git push
```

--------------------------------

### Modular Startup class registering dependencies and plugins

Source: https://docs.servicestack.net/net-ioc

Example of a Modular Startup class (IHostingStartup) that registers dependencies and plugins using IServiceCollection extension methods, and uses ConfigureAppHost to run startup logic that requires access to registered dependencies.

```csharp
public class ConfigureDb : IHostingStartup
{
    public void Configure(IWebHostBuilder builder) => builder
        .ConfigureServices((context, services) => {
            services.AddSingleton<IDbConnectionFactory>(new OrmLiteConnectionFactory(
                context.Configuration.GetConnectionString("DefaultConnection"),
                SqliteDialect.Provider));
            
            // Enable Audit History
            services.AddSingleton<ICrudEvents>(c =>
                new OrmLiteCrudEvents(c.GetRequiredService<IDbConnectionFactory>()));
            
            // Enable AutoQuery RDBMS APIs
            services.AddPlugin(new AutoQueryFeature {
                 MaxLimit = 1000,
            });

            // Enable AutoQuery Data APIs
            services.AddPlugin(new AutoQueryDataFeature());
            
            // Enable built-in Database Admin UI at /admin-ui/database
            services.AddPlugin(new AdminDatabaseFeature());
        })
        .ConfigureAppHost(appHost => {
            appHost.Resolve<ICrudEvents>().InitSchema();
        });
}
```

--------------------------------

### Add gRPC dependencies to pubspec.yaml

Source: https://docs.servicestack.net/flutter

Required dependencies for using protobuf and gRPC in a Flutter project. Install them by running 'pub get' or clicking 'Get Dependencies' in the IDE.

```yaml
dependencies:
  fixnum: ^0.10.11
  async: ^2.2.0
  protobuf: ^1.0.1
  grpc: ^2.1.3

```

--------------------------------

### Quick install with mix - SQL Server

Source: https://docs.servicestack.net/ormlite/installation.html

Use the mix tool to install the SQL Server provider in an ASP.NET Core project. This installs the NuGet package and creates a Modular Startup configuration.

```bash
npx add-in sqlserver
```

--------------------------------

### Configure DefaultMethodsForAny for gRPC

Source: https://docs.servicestack.net/grpc/

Specify which HTTP methods generate rpc endpoints for all Any services. By default only Get*, Post*, Put*, and Delete* are generated; this example restricts to Get and Post.

```csharp
Plugins.Add(new GrpcFeature(App) {
    DefaultMethodsForAny = new List<string> { 
        HttpMethods.Get,
        HttpMethods.Post,
    }
});
```

--------------------------------

### ModularStartup prioritization example with [Priority] attribute

Source: https://docs.servicestack.net/modular-startup-legacy

Shows execution order of startup classes using [Priority]. Negative priorities run before the app's Startup, positive after, in ascending order. The example prints #1 through #9 to illustrate the order.

```csharp
[Priority(-1)]
public class MyPreConfigureServices : IConfigureServices
{
    public void Configure(IServiceCollection services) => "#1".Print();
}

public class MyConfigureServices : IConfigureServices
{
    public void Configure(IServiceCollection services) => "#4".Print();
}

[Priority(1)]
public class MyPostConfigureServices : IConfigureServices
{
    public void Configure(IServiceCollection services) => "#5".Print();
}

[Priority(-1)]
public class MyStartup : IStartup
{
    public IServiceProvider ConfigureServices(IServiceCollection services)
    {
        "#2".Print();
        return null;
    }

    public void Configure(IApplicationBuilder app) => "#6".Print();
}

public class Startup : ModularStartup
{
    public Startup(IConfiguration configuration) : base(configuration){}

    public new void ConfigureServices(IServiceCollection services) => "#3".Print();

    public void Configure(IApplicationBuilder app, IHostingEnvironment env) => "#8".Print();
}

[Priority(-1)]
public class MyPreConfigureApp : IConfigureApp
{
    public void Configure(IApplicationBuilder app)=> "#7".Print();
}

public class MyConfigureApp : IConfigureApp
{
    public void Configure(IApplicationBuilder app)=> "#9".Print();
}
```

--------------------------------

### Insert row and read auto-populated Guid Id

Source: https://docs.servicestack.net/ormlite/reference-support

After db.Insert() or db.Save(), the Id property is populated with the new Guid value. The example shows inserting a row and then reading row.Id.

```csharp
var row = new Table { ... };
db.Insert(row);
row.Id //= Auto populated with new Guid
```

--------------------------------

### Run hello examples

Source: https://docs.servicestack.net/rust-add-servicestack-reference

Commands to run the hello and hello_blocking examples. The hello example uses typed APIs, batched requests, structured validation errors, and authenticated requests. hello_blocking uses the sync client and requires the blocking feature.

```bash
cargo run --example hello
```

```bash
cargo run --example hello_blocking --features blocking
```

--------------------------------

### Step 1: Top-level host builder in Program.cs

Source: https://docs.servicestack.net/modular-startup

Migrate ConfigureServices and Configure(IApplicationBuilder) from Startup : ModularStartup to the top-level host builder in Program.cs. This example shows the basic structure with exception handling and HTTPS redirection for non-development environments.

```csharp
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. 
    // You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
    app.UseHttpsRedirection();
}

app.Run();
```

--------------------------------

### Run PHP example

Source: https://docs.servicestack.net/grpc/php

Execute the PHP script main.php.

```bash
$ php main.php
```

--------------------------------

### Use Setup callback to configure extension after load

Source: https://docs.servicestack.net/chat/configuration

Shows how to use the Setup callback to modify an extension's properties after configuration and providers load but before extensions install. Here it sets DefaultTake from ApiTools.DefaultTake.

```csharp
services.AddPlugin(new ChatFeature {
    Extensions = { new BookingToolsExtension() },
    Setup = ctx => {
        ctx.AssertExtension<BookingToolsExtension>().DefaultTake = ctx.ApiTools.DefaultTake;
    },
});
```

--------------------------------

### Using StringBuilderCache.Allocate and ReturnAndFree

Source: https://docs.servicestack.net/releases/2016-summary

Example of using StringBuilderCache to reuse StringBuilder instances and reduce heap allocations. Call Allocate() to get a reset StringBuilder and ReturnAndFree() to get the string and return the builder to the cache.

```csharp
public static string ToMd5Hash(this Stream stream)
{
    var hash = MD5.Create().ComputeHash(stream);
    var sb = StringBuilderCache.Allocate();
    for (var i = 0; i < hash.Length; i++)
    {
        sb.Append(hash[i].ToString("x2"));
    }
    return StringBuilderCache.ReturnAndFree(sb);
}
```

--------------------------------

### Run insecure Go example

Source: https://docs.servicestack.net/grpc/go

Runs the insecure Go client example.

```bash
$ go run client\main.go
```

--------------------------------

### .NET JsvServiceClient usage

Source: https://docs.servicestack.net/jsv-format

Example of using the .NET JsvServiceClient to send a GET request and receive a response.

```csharp
var client = new JsvServiceClient(baseUrl);
var response = client.Get(new Hello { Name = "World" });
```

--------------------------------

### Create main.rb with the above Ruby Example

Source: https://docs.servicestack.net/grpc/ruby

Command to create the main.rb file using the npx add-in tool.

```bash
$ npx add-in todoworld-ruby
```

--------------------------------

### Create Program.java for insecure example

Source: https://docs.servicestack.net/grpc/java

Command to create Program.java using the npx add-in for the insecure example.

```bash
$ npx add-in todoworld-java
```

--------------------------------

### REST Services Example with encrypted client

Source: https://docs.servicestack.net/auth/encrypted-messaging

Uses the Get method on the encrypted client for REST-style requests.

```csharp
HelloResponse response = encryptedClient.Get(new Hello { Name = "World" });
```

--------------------------------

### Async OrmLite Example

Source: https://docs.servicestack.net/ormlite/customer-orders-example

This async example demonstrates inserting and saving entities, querying by email, and using a transaction to save an order with details. It shows how to get auto-inserted IDs and how to update an entity on the second save.

```csharp
await db.InsertAsync(new Employee { Id = 1, Name = "Employee 1" });
await db.InsertAsync(new Employee { Id = 2, Name = "Employee 2" });
var product1 = new Product { Id = 1, Name = "Product 1", UnitPrice = 10 };
var product2 = new Product { Id = 2, Name = "Product 2", UnitPrice = 20 };
await db.SaveAsync(product1, product2);

var customer = new Customer {
    FirstName = "Orm",
    LastName = "Lite",
    Email = "ormlite@servicestack.net",
    PhoneNumbers =
    {
        { PhoneType.Home, "555-1234" },
        { PhoneType.Work, "1-800-1234" },
        { PhoneType.Mobile, "818-123-4567" },
    },
    Addresses =
    {
        { AddressType.Work, new Address { 
            Line1 = "1 Street", Country = "US", State = "NY", City = "New York", ZipCode = "10101" } 
        },
    },
    CreatedAt = DateTime.UtcNow,
};

var customerId = await db.InsertAsync(customer, selectIdentity: true); //Get Auto Inserted Id
customer = await db.SingleAsync<Customer>(new { customer.Email }); //Query

//Direct access to System.Data.Transactions:
using var trans = db.OpenTransaction(IsolationLevel.ReadCommitted);
var order = new Order {
    CustomerId = customer.Id,
    EmployeeId = 1,
    OrderDate = DateTime.UtcNow,
    Freight = 10.50m,
    ShippingAddress = new Address { 
        Line1 = "3 Street", Country = "US", State = "NY", City = "New York", ZipCode = "12121" },
};
await db.SaveAsync(order); //Inserts 1st time

//order.Id populated on Save().
var orderDetails = new[] {
    new OrderDetail {
        OrderId = order.Id,
        ProductId = product1.Id,
        Quantity = 2,
        UnitPrice = product1.UnitPrice,
    },
    new OrderDetail {
        OrderId = order.Id,
        ProductId = product2.Id,
        Quantity = 2,
        UnitPrice = product2.UnitPrice,
        Discount = .15m,
    }
};

await db.SaveAsync(orderDetails);

order.Total = orderDetails.Sum(x => x.UnitPrice * x.Quantity * x.Discount) + order.Freight;

await db.SaveAsync(order); //Updates 2nd Time

trans.Commit();
```

--------------------------------

### Create new Project Templates with x new

Source: https://docs.servicestack.net/dotnet-tool

Run `x new` to see available project templates.

```bash
x new
```

--------------------------------

### Quick install with mix - Oracle

Source: https://docs.servicestack.net/ormlite/installation.html

Use the mix tool to install the Oracle provider in an ASP.NET Core project. This installs the NuGet package and creates a Modular Startup configuration.

```bash
npx add-in oracle
```

--------------------------------

### JavaScript setup for colorOptions using useMetadata

Source: https://docs.servicestack.net/vue/use-metadata

Vue component setup that uses useMetadata to get property and propertyOptions functions, then computes colorOptions from the CreateContact.Color property. The returned object includes enumOptions and colorOptions for the template.

```javascript
const Edit = {
    //...
    setup(props) {
        const { property, propertyOptions, enumOptions } = useMetadata()
        const colorOptions = propertyOptions(property('CreateContact','Color'))
        return { enumOptions, colorOptions }
        //..
    }
}
```

--------------------------------

### Start AI Server with Docker Compose

Source: https://docs.servicestack.net/ai-server/configuration

Runs docker compose up to start the AI Server for the first time after setting the .env file. This performs initial setup and saves provider configuration in the SQLite database.

```sh
docker compose up
```

--------------------------------

### SQS MQ Server example with EmailContact

Source: https://docs.servicestack.net/amazon-sqs-mq

Configures and starts an SqsMqServer for the EmailContact service, similar to other MQ Servers.

```csharp
container.Register<IMessageService>(c => new SqsMqServer(
    AwsConfig.AwsAccessKey, AwsConfig.AwsSecretKey, RegionEndpoint.USEast1) {
    DisableBuffering = true, // Trade-off latency vs efficiency
});

var mqServer = container.Resolve<IMessageService>();
mqServer.RegisterHandler<EmailContacts.EmailContact>(ExecuteMessage);

AfterInitCallbacks.Add(appHost => mqServer.Start());
```

--------------------------------

### appsettings.json example for NetCoreAppSettings

Source: https://docs.servicestack.net/releases/

JSON configuration example showing the appropriate JSON data types for the settings used with NetCoreAppSettings.

```json
{
    "DebugMode": true,
    "MyConfig": {
        "Name": "Kurt",
        "Age": 27
    },
    "oauth.facebook.Permissions": ["email"],
    "oauth.github.Scopes": ["user"]
}
```

--------------------------------

### Publish output example

Source: https://docs.servicestack.net/netcore-windows-desktop

Example output after publishing to a gist, showing the gist URL and how to run the app.

```bash
published to: https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c

Run published App:

    app open spirals
```

--------------------------------

### Setup Jupyter for C# locally

Source: https://docs.servicestack.net/jupyter-notebooks-csharp

Commands to install JupyterLab, the .NET Interactive tool, and register the dotnet kernels with Jupyter.

```bash
# Install jupyterlab to default Python interpreter
pip install jupyterlab
# Install Dotnet Interactive dotnet tool
dotnet tool install -g Microsoft.dotnet-interactive
# Get Dotnet Interactive to register kernels with Jupyter  
dotnet interactive jupyter install
```

--------------------------------

### Call APIs with custom URLs using GET and POST

Source: https://docs.servicestack.net/javascript-client

Use relative or absolute URLs with client.get, and POST Request DTOs to custom URLs with postToUrl and putToUrl. The example shows GET with query parameters and POST/PUT to custom paths.

```TypeScript
client.get<GetTechnologyResponse>("/technology/ServiceStack")

client.get<GetTechnologyResponse>("http://techstacks.io/technology/ServiceStack")

// GET http://techstacks.io/technology?Slug=ServiceStack
client.get<GetTechnologyResponse>("/technology", { Slug: "ServiceStack" }) 
```

```TypeScript
client.postToUrl("/custom-path", request, { Slug: "ServiceStack" });

client.putToUrl("http://example.org/custom-path", request);
```
Tokens:
Raw