Documentation
Project Templates Vue AutoQuery Auth OrmLite Redis Locode gRPC AI Server
Project Templates Vue AutoQuery Auth OrmLite Redis Locode gRPC AI Server

Overview

  • Why ServiceStack
  • Architecture Overview
  • Servicify existing Systems
  • Explore ServiceStack

Releases

  • Latest Release Notes
  • Release Notes History
  • Pre-release NuGet Packages

Getting Started

  • Create your first WebService
  • Your first WebService explained
  • Service API Design
  • Service Return Types
  • Design RESTful Services
  • Design Message-based APIs
  • Modular Startup
  • dotnet tool - Win/Mac/Linux Utils
  • npx get-dtos
  • x new - Project Template
  • app tool - .NET Windows Desktop
  • mix tool - Mix n' Match .NET Apps
  • Post Command - Inspect HTTP APIs

Background Concepts

  • What is a Message-based Web Service
  • Advantages of message-based Services
  • Why Remote Services should use DTOs
  • Complexity, Services and Role of DTOs
  • API First Development

UIs

  • Auto HTML API
  • API Explorer
  • Locode
  • Admin UI
  • Admin Analytics UI
  • Admin Identity Users UI
  • Admin Identity Roles UI
  • Admin Manage Users UI
  • Admin Redis
  • Admin Database
  • Admin DB Validation UI
  • Admin Logging & Profiling UI
  • Admin UI Features

Reference

  • AppHost
  • IOC
  • ASP.NET Core IOC
  • Routing
  • Endpoint Routing
  • Rate Limiting
  • Order of Operations
  • Customize HTTP Responses
  • Customize JSON Responses
  • Configuration & AppSettings
  • Metadata Pages
  • ServiceStack.AI
  • SVG Support
  • REST, SOAP & default endpoints
  • SOAP support

Error Handling

  • Overview
  • Validation
  • World Validation
  • Declarative Validation
  • Debugging

Clients

  • Overview
  • C#/.NET Client
  • TypeScript Client
  • JavaScript Client
  • Java Client
  • Swift Client
  • Dart Client
  • Service Gateway
  • MQ Clients

Add ServiceStack Reference

  • Overview
  • C# Add Reference
  • TypeScript Add Reference
  • JavaScript Add Reference
  • Python Add Reference
  • PHP Add Reference
  • Swift Add Reference
  • Java Add Reference
  • Kotlin Add Reference
  • Dart Add Reference
  • F# Add Reference
  • VB.NET Add Reference
  • ES3 Common.js Add Reference

Server Events

  • Overview
  • C# Client
  • TypeScript Client
  • Java Client
  • JavaScript Client
  • gRPC Clients
  • Redis Server Events

Background Jobs

  • Overview
  • Schedule Recurring Tasks
  • Commands

MQ Messaging

  • Overview
  • Background MQ
  • Rabbit MQ
  • Redis MQ
  • Amazon SQS MQ
  • Azure Service Bus MQ

Jupyter Notebooks

  • Overview
  • Python Jupyter Notebooks
  • C# Jupyter Notebooks
  • F# Jupyter Notebooks
  • Jupyter Reporting

GitHub Action Templates

  • Overview
  • GitHub GHR & SSH Docker Compose
  • Kamal with GitHub Actions
  • GitHub GHR & Digital Ocean
  • AWS ECR & ECS with NGINX

Encrypted Messaging

  • Overview

Advanced

  • Logging
  • Request & Response filters
  • Filter attributes
  • Access HTTP features in services
  • Serialization & Deserialization
  • Auto-Mapping
  • Auto Batched Requests
  • Virtual File System
  • Multitenancy
  • Physical Project Structure
  • Modularizing Services
  • Built-in profiling
  • Hot Reloading
  • HTML, CSS and JS Minifiers
  • Unified Navigation
  • App Tasks
  • MVC Integration
  • ServiceStack Integration
  • Run side-by-side with another fx
  • Versioning
  • Config API
  • Concurrency Model
  • Form Hijacking Prevention
  • Create a WebService from scratch

Formats

  • Overview
  • JSON Format
  • System.Text.Json APIs
  • CSV Format
  • JSV Format
  • JSON Lines Format
  • MessagePack Format
  • ProtoBuf Format
  • HTML5 Report Format

.NET Core

  • Overview
  • .NET Core Redis
  • Configure localhost dev cert
  • Deploy to Amazon Linux 2 AMI
  • Deploy .NET Core Apps to AWS ECS
  • Deploy .NET Core Apps using rsync

Utils

  • Text Utils
  • HTTP Utils
  • Dump Utils
  • Reflection Utils
  • JS Utils
  • Adhoc Utils
  • Simple IOC

Caching

  • Overview
  • HTTP Caching
  • CacheResponse Attribute
  • Cache Aware Clients
  • Compression

Plugins

  • Overview
  • Open API v3
  • Open API v2
  • CORS Feature
  • Proxy Feature
  • Request logger
  • SQLite Request Logs
  • Lisp TCP REPL Server
  • Postman
  • Sitemaps
  • Cancellable Requests
  • Webhooks

View Engines

  • ServiceStack Razor
  • Razor UI Controls
  • Razor Notes
  • View and Template Selection
  • Compiled Razor Views
  • Razor Views vs Content Pages

JavaScript Web Apps

  • Vue Components
  • Embedded UMD @servicestack/client
  • ss-utils.js JavaScript Client Library

Hosts

  • IIS
  • Self-hosting

Tests

  • Testing
  • HowTo write unit & integration tests

Blazor

  • Blazor WASM Tailwind
  • Blazor Server Tailwind
  • Blazor WASM Bootstrap
  • Blazor Components
  • Blazor Diffusion
  • File Blazor Demo

Java

  • Java ServiceStack Resources
  • Android Studio & IntelliJ

Other Languages

  • Swift
  • F#
  • VB.NET

Deployment

  • Deploy Multiple Sites to single AWS
  • Simple Deployments with WebDeploy
  • Deployments with OctopusDeploy

Amazon Web Services

  • Overview
  • PocoDynamo
  • Getting Started with AWS

Azure

  • Overview

Stripe

  • Overview

Install 3rd Party Products

  • Redis on Windows
  • RabbitMQ on Windows
  • Redis SSL on Azure
  • RHEL 9 Cryptography

Performance

  • Real world performance

Future

  • Roadmap

NHibernate

Community Resources​

  • Using NHibernate with ServiceStack by @philliphaydon
  • OrmLite Blobbing done with NHibernate and Serialized JSON by @philliphaydon
Edit this page on GitHub