Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Your first webservice explained

JaKXz edited this page · 14 revisions

  1. Getting Started

    1. Creating your first project
      1. Create Service from scratch
    2. Your first webservice explained
    3. ServiceStack's new API Design
    4. Designing a REST-ful service with ServiceStack
    5. Example Projects Overview
    6. 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 Reference
      2. F# Add Reference
      3. VB.NET Add Reference
      4. Swift Add Reference
      5. Java Add 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
    2. Markdown Razor
  6. Hosts

    1. IIS
    2. Self-hosting
    3. Messaging
    4. Mono
  7. Security

    1. Authentication/authorization
    2. Sessions
    3. Restricting Services
  8. Advanced

    1. Configuration options
    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. ServiceStack Integration
    18. Embedded Native Desktop Apps
    19. 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. Server Sent Events
    3. Swagger API
    4. Postman
    5. Request logger
    6. 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. Swift Add 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
      1. HTML, CSS and JS Minifiers
    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
Clone this wiki locally

Let's look a bit deeper into the Hello World service you created:

As you have seen, the convention for response DTO is RequestDTO and RequestDTOResponse. Note, request and response DTO should be in the same namespace if you want ServiceStack to recognize the DTO pair.

To support automatic exception handling, you also need to add a ResponseStatus property to the response DTO:

//Request DTO
public class Hello
    public string Name { get; set; }

//Response DTO
//Follows naming convention
public class HelloResponse
    public ResponseStatus ResponseStatus { get; set; } //Automatic exception handling

    public string Result { get; set; }

A service class is marked as such by its inheritance of the empty IService interface. You will generally want to do so by having such a class inherit from the more convenient Service base class which provides easy access to the most common functionality.

public class HelloService : Service
    public object Any(Hello request)
        return new HelloResponse { Result = "Hello, " + request.Name };

The above service can be called with Any HTTP Verb (e.g. GET, POST,..) and from any endpoint or format (e.g. JSON, XML, etc). You can also choose to handle a specific Verb by changing the method name to suit, e.g. here's how to change it so you only handle HTTP GET requests:

public class HelloService : Service
    public object Get(Hello  request)
        return new HelloResponse { Result = "Hello, " + request.Name };

To register your custom REST URLs, you can use the Route attribute on the request DTO:

//Request DTO
public class Hello
    public string Name { get; set; }

Calling your web service

The above service can now be called with:

var client = new JsonServiceClient(BaseUri);
HelloResponse response = client.Get<HelloResponse>("/hello/World!"); 

You can also make it even easier for your C# clients if you also provide the expected return type. E.g. if you add the IReturn<T> interface marker to your Request DTO like:

public class Hello : IReturn<HelloResponse>
    public string Name { get; set; }

Your clients will now also be able to make the same call above but with a fully-typed C# API, i.e:

HelloResponse response = client.Get(new Hello { Name = "World!" });

In general we think you should look to decorate your Request DTO's with the above marker as it will give your clients the choice on which C# client API they prefer to use.

More details on the Service Clients is available on the C# Clients page.

Routing Tips


only matches:






More details about Routing is available on the Routing page.

Next wikipage: The IoC container

Something went wrong with that request. Please try again.