Home

Welcome to the ServiceStack wiki!

Where can I ask questions?

• StackOverflow - hashtag #servicestack - Ask here if you need help! (never via twitter)
• ServiceStack G+ Community (Get in touch with the ServiceStack Community!)
• JabbR ServiceStack chat room
• The Definitive list of Example Projects, Use-Cases, Demos, Starter Templates

Resources

• Release Notes
• Architecture Overview
• Official ServiceStack website
• Trello board (View current project status | To-do/Doing)

---

• ServiceStack's packages available on NuGet
• or, the latest published ServiceStack dll's

---

• Contributors Special thanks to all of ServiceStack's Contributors
• Community-Resources (Blog Posts, Gists, StackOverflow, Pod casts...)
• How to contribute (say thanks to ServiceStack!)

Documentation

This is the documentation about the core web service framework. The documentation for the Redis client, ORMLite etc can be found here.

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. Create your first webservice
   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
2. Reference
   1. Order of Operations
   2. The IoC container
   3. Metadata page
   4. Rest, SOAP & default endpoints
   5. SOAP support
   6. Routing
   7. Service return types
   8. Customize HTTP Responses
   9. Plugins
   10. Validation
   11. Error Handling
   12. Security
3. Clients
   1. Overview
   2. C# client
   3. Silverlight client
   4. JavaScript client
   5. Dart Client
   6. 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 4. Razor & Markdown Razor
   • View and Template Selection
   • Razor Views vs Content Pages
   • Self-Hosted Razor Views
   • Theming Razor Views
   5. Markdown Razor
6. Hosts
   1. IIS
   2. Self-hosting
   3. Mono
      • Run ServiceStack as a daemon on Linux
      • Run ServiceStack in Fastcgi hosted on nginx
      • Linux-Hosting-Options
7. 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. Messaging and Redis
   11. Form Hijacking Prevention
   12. Auto-Mapping
   13. HTTP Utils
   14. Virtual File System
   15. Config API
   16. Physical Project Structure
   17. Modularizing Services
8. Plugins
   1. Sessions
   2. Authentication/authorization
      • Open Id 2.0 Support
   3. Request logger
   4. Swagger API
9. Tests
   1. Testing
   2. HowTo write unit/integration tests
10. Other Languages
    1. FSharp
    2. VB.NET
11. Use Cases
    1. Single Page Apps
    2. Azure
    3. Logging
    4. Bundling and Minification
    5. NHibernate
12. Performance
    1. Real world performance
13. 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
14. Future
    1. Roadmap