Skip to content
Arxisos edited this page Jan 29, 2012 · 18 revisions

If you want to support SOAP, you have to note some important things, because of the lack of other HTTP verbs except of POST in SOAP.

Rest only

If you only want to support REST, you can take the easy route:

//Request DTO
public class Customers {...}
public class CustomersService : RestServiceBase<Customers>
{
    //Get customers
    public override OnGet(Customers request) {...}
    
    //Add customer
    public override OnPost(Customers request) {...}
    
    //Update customer
    public override OnPut(Customers request) {...}
    
    //Delete customer
    public override OnDelete(Customers request) {...}
}
//In the AppHost's configure method
Routes.Add<Customers>("/customers")
    .Add<Customers>("/customers/{Id}");

Soap + Rest

SOAP only supports POST requests. But the REST example makes use of GET, DELETE (...) requests, which aren't available with SOAP. So if you want to support SOAP and REST, you need to create one service for each operation:

//Request DTO
public class GetCustomers {...}
//Service
GetCustomersServiceBase : ServiceBase<GetCustomers> {
   object Run(GetCustomers request){...}
}

//Request DTO
public class AddCustomer {...}
//Service
AddCustomerServiceBase : ServiceBase<AddCustomer>  {
   object Run(AddCustomer request){...}
}

//Request DTO
public class UpdateCustomer {...}
//Service
UpdateCustomerServiceBase : ServiceBase<UpdateCustomer> {
   object Run(UpdateCustomer request){...}
}

//Request DTO
public class DeleteCustomer {...}
//Service
DeleteCustomerServiceBase : ServiceBase<DeleteCustomer> {
   object Run( DeleteCustomer  request){...}
}

The method Run gets executed on each HTTP verb and on each endpoint.

SOAP also excepts that each request always returns the same response DTO. So you need to follow the response DTO naming convention, otherwise ServiceStack won't be able to generate the WSDLs and the SOAP endpoint won't work.

Naming convention: {Request DTO Name} + Response

Example: Request DTO: DeleteCustomer --> Response DTO: DeleteCustomerResponse.

If you would leave the services as they are, the REST endpoint wouldn't exist. So you need to hook them all up on the same URL like that:

//In the AppHost's configure method
Routes.Add<GetCustomers>("/customers", "GET")
  .Add<GetCustomers>("/customers/{Id}", "GET")
  .Add<AddCustomer>("/customers", "POST")
  .Add<UpdateCustomer>("/customers/{Id}", "PUT")
  .Add<DeleteCustomer>("/customers/{Id}", "DELETE")

Note: Don't forget to specify the HTTP verb filters!

Now this webservice supports REST and SOAP and has the same REST endpoint as the above service, they equal 1:1.



  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. 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
    13. Debugging
  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
    1. 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. MVC Integration
  9. Plugins 3. Request logger 4. Swagger API
  10. Tests
    1. Testing
    2. HowTo write unit/integration tests
  11. Other Languages
    1. FSharp
    2. VB.NET
  12. Use Cases
    1. Single Page Apps
    2. Azure
    3. Logging
    4. Bundling and Minification
    5. NHibernate
  13. Performance
    1. Real world performance
  14. 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
  15. Future
    1. Roadmap

Clone this wiki locally