Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP


Demis Bellot edited this page · 13 revisions

  1. Getting Started

    1. Creating your first project
      1. Create Service from scratch
    2. Your first webservice explained
    3. ServiceStack's new API Design
    4. Designing a REST-ful service with ServiceStack
    5. Example Projects Overview
    6. Learning Resources
  2. Reference

    1. Order of Operations
    2. The IoC container
    3. Configuration and AppSettings
    4. Metadata page
    5. Rest, SOAP & default endpoints
    6. SOAP support
    7. Routing
    8. Service return types
    9. Customize HTTP Responses
    10. Plugins
    11. Validation
    12. Error Handling
    13. Security
    14. Debugging
    15. JavaScript Client Library (ss-utils.js)
  3. Clients

    1. Overview
    2. C#/.NET client
    3. Add ServiceStack Reference
      1. C# Add Reference
      2. F# Add Reference
      3. VB.NET Add Reference
      4. Swift Add Reference
    4. Silverlight client
    5. JavaScript client
      1. Add TypeScript Reference
    6. Dart Client
    7. MQ Clients
  4. Formats

    1. Overview
    2. JSON/JSV and XML
    3. ServiceStack's new HTML5 Report Format
    4. ServiceStack's new CSV Format
    5. MessagePack Format
    6. ProtoBuf Format
  5. View Engines

    1. Razor & Markdown Razor
    2. Markdown Razor
  6. Hosts

    1. IIS
    2. Self-hosting
    3. Messaging
    4. Mono
  7. Security

    1. Authentication/authorization
    2. Sessions
    3. Restricting Services
  8. Advanced

    1. Configuration options
    2. Access HTTP specific features in services
    3. Logging
    4. Serialization/deserialization
    5. Request/response filters
    6. Filter attributes
    7. Concurrency Model
    8. Built-in caching options
    9. Built-in profiling
    10. Form Hijacking Prevention
    11. Auto-Mapping
    12. HTTP Utils
    13. Virtual File System
    14. Config API
    15. Physical Project Structure
    16. Modularizing Services
    17. ServiceStack Integration
    18. Embedded Native Desktop Apps
    19. Auto Batched Requests
  9. Server Events

    1. Overview
    2. JavaScript Client
    3. C# Server Events Client
    4. Redis Server Events
  10. Plugins

    1. Auto Query
    2. Server Sent Events
    3. Swagger API
    4. Postman
    5. Request logger
    6. Sitemaps
  11. Tests

    1. Testing
    2. HowTo write unit/integration tests
  12. ServiceStackVS

    1. Install ServiceStackVS
    2. Add ServiceStack Reference
    3. AngularJS App Template
    4. ReactJS App Template
  13. Other Languages

    1. FSharp
      1. Add ServiceStack Reference
    2. VB.NET
      1. Add ServiceStack Reference
    3. Swift
      1. Swift Add Reference
  14. Deployment

    1. Deploy Multiple Sites to single AWS Instance
      1. Simple Deployments to AWS with WebDeploy
    2. Advanced Deployments with OctopusDeploy
  15. Install 3rd Party Products

    1. Redis on Windows
    2. RabbitMQ on Windows
  16. Use Cases

    1. Single Page Apps
      1. HTML, CSS and JS Minifiers
    2. Azure
      1. Connecting to Azure Redis via SSL
    3. Logging
    4. Bundling and Minification
    5. NHibernate
  17. Performance

    1. Real world performance
  18. How To

    1. Sending stream to ServiceStack
    2. Setting UserAgent in ServiceStack JsonServiceClient
    3. ServiceStack adding to allowed file extensions
    4. Default web service page how to
  19. Future

    1. Roadmap
Clone this wiki locally

A more complete listing of ServiceStack NuGet packages is maintained at:

Install ServiceStack Web Service Framework via NuGet

To make it easier for developers to get started we're now maintaining NuGet packages for ServiceStack and its components.

If you have NuGet installed, the easiest way to get started is to install ServiceStack via NuGet:

ServiceStack with Razor Support: Create an empty ASP.NET Web or Console Application and (.NET 4.0+) Install-Package ServiceStack.Razor Install-Package ServiceStack.Razor

If you want just the binaries added to your web application, you just need to install Install-Package ServiceStack Install-Package ServiceStack

Pre-configured Starter template with AppHost + Basic REST service examples

If you want to host ServiceStack Side-by-Side with MVC: Hosted at /api - Create an empty MVC Web Application and Install-Package ServiceStack.Host.Mvc Install-Package ServiceStack.Host.Mvc

Otherwise if you just want ServiceStack hosted at / - Create an empty ASP.NET Web Application and Install-Package ServiceStack.Host.Aspnet Install-Package ServiceStack.Host.Aspnet

This automates the following manual steps:

  • Add the ServiceStack dlls to your standard VS.NET ASP.NET Web Application
  • Register the ServiceStack handler in your Web.Config
  • Configure your AppHost
  • Create a Hello web service
  • Create a TODO REST-ful web service

The above NuGet packages include a simple Hello World service and a REST service back-end for a simple TODO application.

Although we believe this to be a popular starting point, it is not the only one as we have examples of Windows Services, Stand-alone Console Hosts, Hosting together with an existing web framework at a Custom Path - Templates available in the /StarterTemplates folder in the ServiceStack.Examples project.

NuGet ServiceStack.Text

Downloadable separately from ServiceStack itself is its string powers. Inside ServiceStack.Text are some of .NET's fastest Text Serializers:

Install-Package ServiceStack.Text Install-Package ServiceStack.Text

NuGet ServiceStack.Redis

With a hope to introduce more .NET developers to the high-performance and productive NoSQL worlds, we also include a full-featured C# Redis client allowing you to build complete apps with it. Redis is the fastest NoSQL database in the world that is capable of achieving about 110000 SETs and 81000 GETs per second.

The C# Redis Client features:

For .NET developers new to Redis, we invite you to check out the following tutorials:

Install-Package ServiceStack.Redis Install-Package ServiceStack.Redis

NuGet ServiceStack.OrmLite

When you're developing small to medium systems and you don't need the features of an advanced heavy-weight ORM, you're sometimes better off with a fast, light-weight POCO ORM. OrmLite fills this niche, where it's just a set of lightweight extension methods on .NET's ADO.NET System.Data interfaces that non-invasively works off POCO's.

It's primary feature over other ORMs is its auto-support for blobs where any complex property is automatically persisted in a schema-less text blob using ServiceStack.Text's fast TypeSerializer. This allows you to persist most web service requests and responses directly into an RDBMS as-is without the tedious tasks of configuring tables, ORM and mapping files.

Currently OrmLite comes in 6 RDBMS's flavours and each are downloadable separately via NuGet: Sql Server, MySql, PostgreSQL, Firebird, Sqlite32 and Sqlite64.

Install-Package ServiceStack.OrmLite.SqlServer Install-Package ServiceStack.OrmLite.SqlServer

Install-Package ServiceStack.OrmLite.PostgreSQL Install-Package ServiceStack.OrmLite.PostgreSQL

Install-Package ServiceStack.OrmLite.Sqlite32 Install-Package ServiceStack.OrmLite.Sqlite32

Install-Package ServiceStack.OrmLite.Sqlite64 Install-Package ServiceStack.OrmLite.Sqlite64

Download published NuGet binaries without NuGet

GitHub has disabled its download feature so currently NuGet is the best way to get ServiceStack published releases. For environments that don't have NuGet installed (e.g. OSX/Linux) you can still download the published binaries by extracting them from the published NuGet packages. The url to download a nuget package is:{PackageName}/{Version}

So to get the core ServiceStack and ServiceStack.Text libs in OSX/Linux (or using gnu tools for Windows) you can just do:

wget -O ServiceStack
unzip ServiceStack 'lib/*'

wget -O ServiceStack.Text
unzip ServiceStack.Text 'lib/*'

which will download and extract the dlls into your local local lib/ folder.

Something went wrong with that request. Please try again.