Professional Documents
Culture Documents
NuGet
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.
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:
<system.web> <httpHandlers> <add path="*" type="ServiceStack.HttpHandlerFactory, ServiceStack" verb="*"/> </httpHandlers> </system.web>
<!-- Required for IIS 7.0 (and above?) --> <system.webServer> <validation validateIntegratedModeConfiguration="false" /> <handlers> <add path="*" name="ServiceStack.Factory" type="ServiceStack.HttpHandlerFactory, ServiceStack" verb="*" preCondition="integratedMode" 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-withanother-web-framework. Note: Due to limitations in IIS 6 - host ServiceStack at a /custompath which must end with .ashx, e.g: path="api.ashx"
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)
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);
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/ServiceStack.Hello/servicestack/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
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>