Home

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
      1. Creating a WebService from scratch
   2. Your first webservice explained
   3. ServiceStack's new API Design
   4. Designing a REST-ful service with ServiceStack
   5. How to design a Message-Based API
   6. Example Projects Overview
      
   7. 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 ServiceStack Reference
      2. F# Add ServiceStack Reference
      3. VB.NET Add ServiceStack Reference
      4. Swift Add ServiceStack 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
      • Razor Notes
      • View and Template Selection
      • Compiled Razor Views
      • Razor Views vs Content Pages
      • Self-Hosted Razor Views
      • Theming Razor Views
   2. Markdown Razor

6. Hosts

   1. IIS
   2. Self-hosting
   3. Messaging
      • Messaging and Redis
      • Rabbit MQ
   4. Mono
      • Run ServiceStack as a daemon on Linux
      • Run ServiceStack in Fastcgi hosted on nginx
      • Linux-Hosting-Options

7. Security

   1. Authentication/authorization
      • Open Id 2.0 Support
   2. Sessions
   3. Restricting Services

8. 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 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. MVC Integration
   18. ServiceStack Integration
   19. Embedded Native Desktop Apps
   20. 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. Swagger API
    3. Postman
    4. Request logger
    5. 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. Add ServiceStack 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
    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