Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
ServiceStack 4 Cookbook
ServiceStack 4 Cookbook

ServiceStack 4 Cookbook: Over 70 recipes to create web services, build message-based apps, and work with object-relational mapping

eBook
R$80 R$245.99
Paperback
R$306.99
Subscription
Free Trial
Renews at R$50p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

ServiceStack 4 Cookbook

Chapter 2. Services and Data Transfer Objects

In this chapter, we will cover the following topics:

  • Creating a basic create/read/update/delete
  • 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

Introduction

At the core of ServiceStack are the services you write and the contract that these services use. The contract is in the form of request-and-response data transfer objects or DTOs. DTOs are at the core of a message-based design that ServiceStack uses to construct typed clients end to end. In this chapter, we will go over creating a basic service to handle resources, structuring your services, and introduce some of the other ways we can extend the services we build through filters and authentication.

Creating a basic create/read/update/delete service

When you're building a REST service, it's important to make good use of the main tool available to you, HTTP. There are multiple books on the subject of what makes a good RESTful service, but here are some of the headlines:

  • URL routes represent resources; they should be nouns, not verbs
  • Services should act predictably to common verbs, for example, GET, POST, PUT, DELETE
  • Use appropriate HTTP status codes for responses

In this recipe, we will build a simple service that will Create, Read, Update, and Delete (CRUD) entries from a database. For a deeper dive into some of the other concepts used in this example, please see the relevant recipes:

  • The Sharing and accessing configuration and common functionality using Funq IoC recipe in Chapter 1, Configuration and Routing
  • The Using and accessing OrmLite recipe in Chapter 4, Object Relational Mapping (OrmLite)
  • The Creating static validation rules using fluent syntax recipe in Chapter 6, Filters...

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...

Hosting services from different assemblies

The output of a .NET project is typically an assembly. This applies to ServiceStack projects also. These assemblies can be in the form of a DLL, which could be used by other programs or by a program itself. In this example, we'll show how you can create and reuse assemblies.

In this example, we'll take the ReidsonMessenger service we've been creating, refactor it a bit to be more modular, and then create a new project to host it.

Getting ready

When we last left off with the ReidsonMessenger service, it had the following structure:

Getting ready

We'll refactor the solution by moving MessengerService out to its own project, which will leave only the hosting details, AppHost and Global.asax, in the main project. Then, we'll create an entirely new solution that hosts the messenger in a console project instead of IIS and add the MessengerService.ServiceModel and MessengerService.ServiceInterface DLLs to it as references.

How to do it…

Right...

Utilizing the original HTTP request

There are a few types of situations when you might need to access the original ASP.NET HttpRequest. You might be migrating to ServiceStack from a large existing WCF code base or another framework where this object was used a lot. You might be required to integrate with a legacy or custom services/clients that are unable to be changed, and your web service endpoints must adhere to a specific set of requests and responses. In this recipe, we will go over some of the options you have when using the ServiceStack framework—the access and use of the original HTTP request object as well as some ways you can leverage how ServiceStack binds values to your request data transfer objects.

Getting ready

You'll need to have your ServiceStack project up and running; please see Creating a ServiceStack solution with VisualStudio and NuGet in Appendix A, Getting Started.

How to do it…

Accessing the original ASP.NET HttpRequest is very simple to do as it...

Overriding serialization of request object types

ServiceStack's fast serialization of requests and responses is at the center of how its clients and services interact. Sometimes, however, there might be a need to have your request objects structured differently on the server than the client. In this recipe, we will cover how this can be handled within the ServiceStack framework.

Getting ready

First, we'll need a project with ServiceStack references to be up and running. To do this, please see Creating a ServiceStack solution with VisualStudio and NuGet in Appendix A, Getting Started.

Although ServiceStack has a simple way of aliasing properties for a request object, sometimes there might be more control needed around how your request-and-response objects serialize and deserialize.

Note

In this recipe, we are looking at only JSON serialization; some of these concepts can be converted into the other formats ServiceStack supports, such as JSV and CSV.

How to do it…

So, in this example...

Introduction


At the core of ServiceStack are the services you write and the contract that these services use. The contract is in the form of request-and-response data transfer objects or DTOs. DTOs are at the core of a message-based design that ServiceStack uses to construct typed clients end to end. In this chapter, we will go over creating a basic service to handle resources, structuring your services, and introduce some of the other ways we can extend the services we build through filters and authentication.

Creating a basic create/read/update/delete service


When you're building a REST service, it's important to make good use of the main tool available to you, HTTP. There are multiple books on the subject of what makes a good RESTful service, but here are some of the headlines:

  • URL routes represent resources; they should be nouns, not verbs

  • Services should act predictably to common verbs, for example, GET, POST, PUT, DELETE

  • Use appropriate HTTP status codes for responses

In this recipe, we will build a simple service that will Create, Read, Update, and Delete (CRUD) entries from a database. For a deeper dive into some of the other concepts used in this example, please see the relevant recipes:

  • The Sharing and accessing configuration and common functionality using Funq IoC recipe in Chapter 1, Configuration and Routing

  • The Using and accessing OrmLite recipe in Chapter 4, Object Relational Mapping (OrmLite)

  • The Creating static validation rules using fluent syntax recipe in Chapter 6, Filters and Validators...

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...

Hosting services from different assemblies


The output of a .NET project is typically an assembly. This applies to ServiceStack projects also. These assemblies can be in the form of a DLL, which could be used by other programs or by a program itself. In this example, we'll show how you can create and reuse assemblies.

In this example, we'll take the ReidsonMessenger service we've been creating, refactor it a bit to be more modular, and then create a new project to host it.

Getting ready

When we last left off with the ReidsonMessenger service, it had the following structure:

We'll refactor the solution by moving MessengerService out to its own project, which will leave only the hosting details, AppHost and Global.asax, in the main project. Then, we'll create an entirely new solution that hosts the messenger in a console project instead of IIS and add the MessengerService.ServiceModel and MessengerService.ServiceInterface DLLs to it as references.

How to do it…

Right-click on the solution and choose...

Left arrow icon Right arrow icon

Description

If you are a .NET developer who is looking for a simpler way to build services, this is the book for you. It will show you how to write fast, maintainable APIs that are a pleasure to use and maintain starting from the database to the client and everything in-between.

Who is this book for?

If you are a .NET developer who is looking for a simpler way to build services, this is the book for you. It will show you how to write fast, maintainable APIs that are a pleasure to use and maintain starting from the database to the client and everything in-between.

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jan 23, 2015
Length: 444 pages
Edition : 1st
Language : English
ISBN-13 : 9781783986569
Concepts :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Jan 23, 2015
Length: 444 pages
Edition : 1st
Language : English
ISBN-13 : 9781783986569
Concepts :

Packt Subscriptions

See our plans and pricing
Modal Close icon
R$50 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
R$500 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just R$25 each
Feature tick icon Exclusive print discounts
R$800 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just R$25 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total R$ 579.98
Mastering ServiceStack
R$272.99
ServiceStack 4 Cookbook
R$306.99
Total R$ 579.98 Stars icon

Table of Contents

12 Chapters
1. Configuration and Routing Chevron down icon Chevron up icon
2. Services and Data Transfer Objects Chevron down icon Chevron up icon
3. Testing and Logging Chevron down icon Chevron up icon
4. Object Relational Mapping (OrmLite) Chevron down icon Chevron up icon
5. HTML and Form Data Chevron down icon Chevron up icon
6. Filters and Validators Chevron down icon Chevron up icon
7. Security and Authentication Chevron down icon Chevron up icon
8. Working with Redis Chevron down icon Chevron up icon
9. Integrating with Other Technologies Chevron down icon Chevron up icon
A. Getting Started Chevron down icon Chevron up icon
B. Testing Locally Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.7
(3 Ratings)
5 star 66.7%
4 star 33.3%
3 star 0%
2 star 0%
1 star 0%
Jason Jul 09, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Great for getting started and/or addressing specific "cookbook" scenarios.
Amazon Verified review Amazon
faisal Jul 06, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
really nice companion to the ServiceStack documentation. Great book to hand off to someone just starting out using service stack. we have made it almost mandatory reading for all new hires that work with SerceStack.
Amazon Verified review Amazon
Ankit Modi Jul 03, 2015
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
This Cookbook is perfect for .Net Developers who want to work with ServiceStack in order to solve web service engineering problems. It has a lot of recipes that will help you troubleshoot common ServiceStack problems. It teaches you how to build message-based apps, write maintainable API's and work with relational mapping.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.