Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Create your first webservice

Lydon Bergin edited this page · 58 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
    20. Versioning
  9. Server Events

    1. Overview
    2. JavaScript Client
    3. C# Server Events Client
    4. Redis Server Events
  10. Encrypted Messaging

    1. Overview
    2. Encrypted Client
  11. Plugins

    1. Auto Query
    2. Server Sent Events
    3. Swagger API
    4. Postman
    5. Request logger
    6. Sitemaps
    7. Cancellable Requests
    8. CorsFeature
  12. Tests

    1. Testing
    2. HowTo write unit/integration tests
  13. ServiceStackVS

    1. Install ServiceStackVS
    2. Add ServiceStack Reference
    3. AngularJS App Template
    4. ReactJS App Template
  14. Other Languages

    1. FSharp
      1. Add ServiceStack Reference
    2. VB.NET
      1. Add ServiceStack Reference
    3. Swift
      1. Swift Add Reference
    4. Java
      1. Add ServiceStack Reference
      2. Android Studio & IntelliJ
      3. Eclipse
  15. Deployment

    1. Deploy Multiple Sites to single AWS Instance
      1. Simple Deployments to AWS with WebDeploy
    2. Advanced Deployments with OctopusDeploy
  16. Install 3rd Party Products

    1. Redis on Windows
    2. RabbitMQ on Windows
  17. 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
  18. Performance

    1. Real world performance
  19. 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
  20. Future

    1. Roadmap
Clone this wiki locally

Fastest way to get started is to create a project with ServiceStack's VS.NET Templates. In addition to this, there are a number of great walk-thru's into ServiceStack in the Community Resources section below. Like this detailed walk-thru with Screenshots by @nilsnagele.

Step 1: Create an application

ServiceStack can be hosted in a few ways: console application, windows service, ASP.NET Web Form or MVC in IIS, etc.

For this tutorial, an empty ASP.NET Web Application (non MVC) is assumed.

Step 2: Install ServiceStack

To install ServiceStack into your application, you have two options to get the binaries:

NuGet

Install-Pacakage ServiceStack

Tip: You can find an explanation about all NuGet packages which ServiceStack offers here. The package above only adds the binaries, but there also exist some packages which add the required configurations etc.

Manual Download

Only current option for manual download is to download source and build yourself.


Register ServiceStack Handler

After you've added the binaries, you need to register ServiceStack in web.config:

If you want to host ServiceStack at root path (/), you should use this configuration:

<!-- For IIS 6.0/Mono -->
<system.web>
  <httpHandlers>    
    <add path="*" type="ServiceStack.HttpHandlerFactory, ServiceStack" verb="*"/>
  </httpHandlers>
</system.web>

<!-- For IIS 7.0+ -->
<system.webServer>
  <validation validateIntegratedModeConfiguration="false" />
  <handlers>
    <add path="*" name="ServiceStack.Factory" preCondition="integratedMode" 
         type="ServiceStack.HttpHandlerFactory, ServiceStack" 
         verb="*" resourceType="Unspecified" allowPathInfo="true" />
  </handlers>
</system.webServer>

Tip: If you want to host your webservice on a custom path to avoid conflicts with another web framework (eg ASP.Net MVC), see https://github.com/ServiceStack/ServiceStack/wiki/Run-servicestack-side-by-side-with-another-web-framework.

Note: Due to limitations in IIS 6 - host ServiceStack at a /custompath which must end with .ashx, e.g: path="api.ashx"

Step 3: Create your first webservice

If Global.asax.cs doesn't already exist you have to add it manually. To do this Right-click on your project and go Add -> New Item, then select the Global Application class.

Each service in ServiceStack consists of three parts:

  • Request DTO
  • Service implementation
  • Response DTO

That's the core philosophy in ServiceStack. Each service has a strongly-typed, code-first (normal POCOs) request DTO and response DTO. You can read a detailed explanation what advantages exist if you're using DTOs in the ReadMe or in Why should I use ServiceStack?.

  1. Create the name of your Web Service (i.e. the Request DTO)
[Route("/hello")]
[Route("/hello/{Name}")]
public class Hello
{
    public string Name { get; set; }
}
  1. Define what your Web Service will return (i.e. Response DTO)
public class HelloResponse
{
    public string Result { get; set; }
}
  1. Create your Web Service implementation
public class HelloService : Service
{
    public object Any(Hello request)
    {
        return new HelloResponse { Result = "Hello, " + request.Name };
    }
} 

Step 4: Registering your web services and starting your application

The final step is to configure setup to tell ServiceStack where to find your web services. To do that, add this code to your Global.asax.cs:

public class Global : System.Web.HttpApplication
{
    public class AppHost : AppHostBase
    {
        //Tell ServiceStack the name of your application and where to find your services
        public AppHost() : base("Hello Web Services", typeof(HelloService).Assembly) { }

        public override void Configure(Funq.Container container)
        {
            //register any dependencies your services use, e.g:
            //container.Register<ICacheClient>(new MemoryCacheClient());
        }
    }

    //Initialize your application singleton
    protected void Application_Start(object sender, EventArgs e)
    {
        new AppHost().Init();
    }
}

Done! You now have a working application :)

As you can see, you have created an AppHost. Mainly all configuration related to ServiceStack is made in the AppHost. It's the starting point in your application.

Disable WebApi from the default MVC4 VS.NET template

If you are using MVC4 then you need to comment line in global.asax.cs to disable WebApi

//WebApiConfig.Register(GlobalConfiguration.Configuration);

ServiceStack is now Ready!

Now that you have a working Web Service lets see what ServiceStack does for you out of the box:

If everything is configured correctly you can go to http://<root_path>/metadata to see a list of your web services and the various end points its available on.

Metadata page

Tip: In the screenshot the root path is http://localhost/ServiceStack.Hello/servicestack. On your development box the root path might be something like http://localhost:60335 (ie the URL on which your webservice is hosted).

Let's access the HelloWorld service you created in your browser, so write the following URL in your address bar:

GET http://<root_path>/hello/YourName eg http://mono.servicestack.net/hello/Max.

As you can see after clicking on this link, ServiceStack also contains a HTML response format, which makes the XML/Json (...) output human-readable. To change the return format to Json, simply add ?format=json to the end of the URL. You'll learn more about formats, endpoints (URLs, etc) when you continue reading the documentation.

Troubleshooting

If you happen to generate requests from the wsdls with a tool like soapUI you may end up with an incorrectly generated request like this:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:typ="http://schemas.servicestack.net/types">
  <soap:Header/>
  <soap:Body>
    <typ:Hello/>
  </soap:Body>
</soap:Envelope>

You can resolve this issue by adding the following line to your AssemblyInfo file

[assembly: ContractNamespace("http://schemas.servicestack.net/types", 
           ClrNamespace = "<YOUR NAMESPACE>")]

Rebuild and regenerate the request from the updated wsdl. You should get a correct request this time.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:typ="http://schemas.servicestack.net/types">
   <soap:Header/>
   <soap:Body>
      <typ:Hello>
         <!--Optional:-->
         <typ:Name>?</typ:Name>
      </typ:Hello>
   </soap:Body>
</soap:Envelope>

Explore more ServiceStack features

The EmailContacts solution is a new guidance available that walks through the recommended setup and physical layout structure of typical medium-sized ServiceStack projects, including complete documentation of how to create the solution from scratch, whilst explaining all the ServiceStack features it makes use of along the way.

Community Resources

Something went wrong with that request. Please try again.