Home

ServiceStack's Documentation is now maintained at docs.servicestack.net

---

Welcome to ServiceStack wiki!

Where can I ask questions?

• StackOverflow - Use servicestack tag for questions on StackOverflow
  • Support options for ServiceStack are listed in your account page: https://servicestack.net/account/support
• ServiceStack G+ Community Get in touch with the ServiceStack Community
• Live Demos!

Resources

• Release Notes
• Architecture Overview
• Official ServiceStack website
• Feature Requests
• Documentation for v3

---

• ServiceStack's packages available on NuGet
  • Pre-release packages available on MyGet

---

• Contributors Special thanks to all of ServiceStack's Contributors
• Community-Resources (Blog Posts, Gists, StackOverflow, Pod casts...)
• Contributing Guide

Documentation

This is the documentation about the core web service framework. Please see the individual projects for documentation on the Redis client, OrmLite or Text Serializers.

Prerequisites - Before you start reading, you should know the basics about HTTP (HTTP methods/verbs, status codes etc) and REST/SOAP

• Why ServiceStack?
• What is a message based web service?
• Advantages of message based web services
• Why remote services should use separate Data Transfer Objects

1. Getting Started

   1. Creating your first Project
   2. Creating a WebService from scratch
   3. Your first webservice explained
   4. Example Projects Overview
   5. Learning Resources

2. Designing APIs

   1. ServiceStack API Design
   2. Designing a REST-ful service with ServiceStack
   3. Simple Customer REST Example
   4. How to design a Message-Based API
   5. Software complexity, goals of Services and important role of DTOs

3. 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. Customize JSON Responses
   11. Plugins
   12. Validation
   13. Error Handling
   14. Security
   15. Debugging
   16. JavaScript Client Library (ss-utils.js)

4. Clients

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

5. Formats

   1. Overview
   2. JSON/JSV and XML
   3. HTML5 Report Format
   4. CSV Format
   5. MessagePack Format
   6. ProtoBuf Format

6. View Engines 4. Razor & Markdown Razor

   • Razor Notes
   • View and Template Selection
   • Compiled Razor Views
   • Razor Views vs Content Pages
   • Self-Hosted Razor Views
   • Theming Razor Views
   5. Markdown Razor

7. Hosts

   1. IIS
   2. Self-hosting
   3. Messaging
      • Rabbit MQ
      • Redis MQ
      • Amazon SQS
   4. Mono
      • Run ServiceStack as a daemon on Linux
      • Recommended guide for hosting on Mono
      • Docker image for running in a docker container
      • Linux-Hosting-Options

8. Security

   1. Authentication and Authorization
      • JWT AuthProvider
      • API Key AuthProvider
      • Open Id 2.0 Support
   2. Sessions
   3. Restricting Services
   4. Encrypted Messaging

9. Advanced

   1. Configuration options
      • Run ServiceStack side-by-side with another web framework
   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 profiling
   9. Form Hijacking Prevention
   10. Auto-Mapping
   11. HTTP Utils
   12. Dump Utils
   13. Virtual File System
   14. Config API
   15. Physical Project Structure
   16. Modularizing Services
   17. MVC Integration
   18. ServiceStack Integration
   19. Embedded Native Desktop Apps
   20. Auto Batched Requests
   21. Versioning
   22. Multitenancy

10. Caching

11. Caching Providers

12. HTTP Caching 1. CacheResponse Attribute 2. Cache Aware Clients

13. Auto Query

14. Overview

15. Why Not OData

16. AutoQuery RDBMS

17. AutoQuery Data 1. AutoQuery Memory 2. AutoQuery Service 3. AutoQuery DynamoDB

18. Server Events

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

19. Service Gateway

    1. Overview
    2. Service Discovery

20. Encrypted Messaging

    1. Overview
    2. Encrypted Client

21. Plugins 3. Swagger API 4. Postman 5. Request logger 6. Sitemaps 7. Cancellable Requests 8. CorsFeature

22. Tests

    1. Testing
    2. HowTo write unit/integration tests

23. ServiceStackVS

    1. Install ServiceStackVS
    2. Add ServiceStack Reference
    3. TypeScript React Template
    4. React, Redux Chat App
    5. AngularJS App Template
    6. React Desktop Apps

24. Other Languages

    1. FSharp
       1. Add ServiceStack Reference
    2. VB.NET
       1. Add ServiceStack Reference
    3. Swift
       1. Add ServiceStack Reference
    4. Java
       1. Add ServiceStack Reference
       2. Android Studio & IntelliJ
       3. Eclipse

25. Amazon Web Services

26. ServiceStack.Aws

27. PocoDynamo

28. AWS Live Demos

29. Getting Started with AWS

30. Deployment

    1. Deploy Multiple Sites to single AWS Instance
       1. Simple Deployments to AWS with WebDeploy
    2. Advanced Deployments with OctopusDeploy

31. Install 3rd Party Products

    1. Redis on Windows
    2. RabbitMQ on Windows

32. Use Cases

    1. Single Page Apps
    2. HTML, CSS and JavaScript Minification
    3. Azure
    4. Connecting to Azure Redis via SSL
    5. Logging
    6. Bundling and Minification
    7. NHibernate

33. Performance

    1. Real world performance

34. Other Products

    1. ServiceStack.Redis
    2. ServiceStack.OrmLite
    3. ServiceStack.Text

35. Future

    1. Roadmap