Book Image

ServiceStack 4 Cookbook

Book Image

ServiceStack 4 Cookbook

Overview of this book

Related Content you might be interested in

Current Title:

Small book image
ServiceStack 4 Cookbook
Jan, 2015 | 444 pages
No titles found
Table of Contents (18 chapters)
ServiceStack 4 Cookbook
ServiceStack 4 Cookbook
Credits
Credits
About the Authors
About the Authors
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Configuration and Routing
Configuration and Routing
Introduction
Up and running with ServiceStack
Routing using data transfer object attributes
Isolating web service routes from a web application
Common ServiceStack plugins
Writing a custom audit plugin
Adding Routes via the API
Structuring your project to avoid dependency issues
Managing dependencies with Funq and Inversion of Control (IoC)
Sharing and accessing configuration and common functionality using Funq IoC
2
Services and Data Transfer Objects
Services and Data Transfer Objects
Introduction
Creating a basic create/read/update/delete service
Splitting HTTP request methods
Hosting services from different assemblies
Utilizing the original HTTP request
Overriding serialization of request object types
Creating a simple admin service
Intercepting requests and responses using attributes
Making a basic proxy for existing web services
Wrapping multiple existing services and exposing them through ServiceStack
3
Testing and Logging
Testing and Logging
Introduction
Unit testing ServiceStack applications
Integration testing with the ServiceStack C# client
Functional contract testing ServiceStack services
Accessing the request-and-response object with the JsonServiceClient
Continuous Integration with TeamCity and self-hosted services
Logging with a choice of frameworks
Writing a logger to monitor exceptions via e-mail
4
Object Relational Mapping (OrmLite)
Object Relational Mapping (OrmLite)
Introduction
Modeling your database with types and attributes
Using and accessing OrmLite
Using OrmLite filters to create audit functionality
CRUD and other common operations
Utilizing stored procedures using OrmLite
Mapping custom queries to POCOs
Starting with an existing database with OrmLite and T4 templates
Working with Entity Framework and ServiceStack
5
HTML and Form Data
HTML and Form Data
Introduction
Getting started with ServiceStack and Razor templates
Using Markdown for website content
Handling file uploads and streaming data from services
Overriding Razor views or templates using attributes
Creating and displaying a login and registration page based on authentication
Submitting a form to a service and handling server-side validation on an HTML client
6
Filters and Validators
Filters and Validators
Introduction
Creating static validation rules using fluent syntax
Returning meaningful HTTP error messages
Adding custom headers via the response filter
Restricting file uploads by type using filters
Creating a user-configurable HTTP callback service using a response filter
Applying a rate limit to a web service endpoint using request filter
Restrict user actions by session details using a validator
Common HTTP status codes
7
Security and Authentication
Security and Authentication
Introduction
Getting started with authentication, sessions, registration, and user repositories
Getting started with Twitter authentication
Getting started with Google authentication

Getting started with Facebook authentication
Using multiple authentication providers and persisting a user's preferred profile image
Handling password resets for credential-based authentication
Accessing Windows identity information from ServiceStack for an intranet application
Validating password complexity with a custom registration validator
Migrating users from another system by overriding ServiceStack's credential-based authentication
Writing your own OpenID authentication provider
8
Working with Redis
Working with Redis
Introduction
Getting started with ServiceStack.Redis
Using Redis as a cache with the ServiceStack client
Using ServiceStack.Redis for publish/subscribe
Using the ServiceStack.Redis client to access a Redis list
Using Redis hash data structures in ServiceStack
Using Redis Set data structures in ServiceStack
Using typed data structures with ServiceStack and Redis
Scripting Redis with Lua
9
Integrating with Other Technologies
Integrating with Other Technologies
Introduction
Integrating with ServiceStack using the C# client and Native Types
Using ServiceStack with WebForms applications
Using ServiceStack with ASP.NET/MVC applications
Broadcasting ServiceStack services with SignalR hubs
Using ServiceStack with MongoDB
Using ServiceStack with Elasticsearch
Working with ServiceStack and AngularJS resources
Getting Started
Getting Started
Creating a ServiceStack solution with Visual Studio and NuGet
Integrating NUnit
Testing Locally
Testing Locally
Testing external service callbacks locally using Fiddler2 and IIS Express
Index
Index

Splitting HTTP request methods

When you're building a REST service, it's good practice to make efficient use of the HTTP protocol to assist you in your design. While full coverage of what makes for good RESTful design is outside the scope of this book, we will cover how to use ServiceStack's built-in tools to help you reuse code.

Note

I recommend REST in Practice, O'Reilly, and APIs: A Strategy Guide, O'Reilly, for more on designing effective RESTful web services.

One project I am acquainted with started out with an RPC-style design. The service owner realized that they had well over 65 endpoints, such as /createNewGroup, /renameGroup, and so on, making it hard for developers to remember the exact name of the endpoint for the function they need. This was overhauled, and the RESTful approach was applied. The end result had only four endpoints and still served the same user base with the same functionality. The end result was a much simpler service that was easier to learn, deploy, and debug...

Previous Section
End of Section 4
Next Section