Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
C# JavaScript HTML CSS ASP Pascal Other

This branch is 87 commits ahead, 2225 commits behind master

Merge pull request #945 from mbischoff/v3

Upgrade Markdown's ShouldSkipPaths as a global Config.ScanSkipPaths opti...
latest commit 8db80e293e
@mythz mythz authored

README.md

See www.servicestack.net for an overview.

Join the ServiceStack Google+ Community or follow @ServiceStack for project updates. You can catch some community members hanging out on JabbR.

Service Stack is a high-performance .NET web services platform that simplifies the development of high-performance REST (JSON, XML, JSV, HTML, MsgPack, ProtoBuf, CSV) and WCF SOAP Web Services.

Note: the source code is provided as-is - no direct or commercial support is available for ServiceStack

Simple REST service example

This example is also available as a stand-alone integration test:

//Web Service Host Configuration
public class AppHost : AppHostHttpListenerBase
{
    public AppHost() : base("TODOs Tests", typeof(Todo).Assembly) {}

    public override void Configure(Container container)
    {
        container.Register(new TodoRepository());
    }
}

//REST Resource DTO
[Route("/todos")]
[Route("/todos/{Ids}")]
public class Todos : IReturn<List<Todo>>
{
    public long[] Ids { get; set; }
    public Todos(params long[] ids)
    {
        this.Ids = ids;
    }
}

[Route("/todos", "POST")]
[Route("/todos/{Id}", "PUT")]
public class Todo : IReturn<Todo>
{
    public long Id { get; set; }
    public string Content { get; set; }
    public int Order { get; set; }
    public bool Done { get; set; }
}

public class TodosService : Service
{
    public TodoRepository Repository { get; set; }  //Injected by IOC

    public object Get(Todos request)
    {
        return request.Ids.IsEmpty()
            ? Repository.GetAll()
            : Repository.GetByIds(request.Ids);
    }

    public object Post(Todo todo)
    {
        return Repository.Store(todo);
    }

    public object Put(Todo todo)
    {
        return Repository.Store(todo);
    }

    public void Delete(Todos request)
    {
        Repository.DeleteByIds(request.Ids);
    }
}

Calling the above TODO REST service from any C#/.NET Client

//no code-gen required, can re-use above DTO's

var restClient = new JsonServiceClient(BaseUri);
List<Todo> all = restClient.Get(new Todos());           // Count = 0

var todo = restClient.Post(
    new Todo { Content = "New TODO", Order = 1 });      // todo.Id = 1
all = restClient.Get(new Todos());                      // Count = 1

todo.Content = "Updated TODO";
todo = restClient.Put(todo);                            // todo.Content = Updated TODO

restClient.Delete(new Todos(todo.Id));
all = restClient.Get(new Todos());                      // Count = 0

Calling the TODO REST service from jQuery

$.getJSON(baseUri, function(todos) {
    alert(todos.length == 1);
});

Calling the TODO REST service from Dart JsonClient

var client = new JsonClient(baseUri);
client.todos()
    .then((todos) => alert(todos.length == 1) ); 

That's all the application code required to create a simple REST web service.

Getting Started

Download

If you have NuGet installed, the easiest way to get started is to install ServiceStack via NuGet:

ServiceStack binaries only: Minimal installation of ServiceStack containing only the core-binaries (.NET 3.5+) Install-Pacakage ServiceStack

ServiceStack with Razor Support: Create an empty ASP.NET Web or Console Application and (.NET 4.0+) Install-Pacakage ServiceStack.Razor2

Note: the binary packages are provided as-is - no direct or commercial support is available for ServiceStack

Examples

The Definitive list of Example Projects, Use-Cases, Demos, Starter Templates

Download published NuGet binaries without NuGet

GitHub has disabled its download feature so currently NuGet is the best way to get ServiceStack published releases. For environments that don't have NuGet installed (e.g. OSX/Linux) you can still download the published binaries by extracting them from the published NuGet packages. The url to download a nuget package is:

http://packages.nuget.org/api/v1/package/{PackageName}/{Version}

So to get the core ServiceStack and ServiceStack.Text libs in OSX/Linux (or using gnu tools for Windows) you can just do:

wget -O ServiceStack http://packages.nuget.org/api/v1/package/ServiceStack/3.9.60
unzip ServiceStack 'lib/*'

wget -O ServiceStack.Text http://packages.nuget.org/api/v1/package/ServiceStack.Text/3.9.60
unzip ServiceStack.Text 'lib/*'

which will download and extract the dlls into your local local lib/ folder.

Release notes for major releases

OSS Libraries used

ServiceStack includes source code of the great libraries below for some of its core functionality. Each library is released under its respective licence:

Similar open source projects

Similar Open source .NET projects for developing or accessing web services include:

  • Nancy Fx - A Sinatra-inspired lightweight Web Framework for .NET:
  • Fubu MVC - A "Front Controller" pattern-style MVC framework designed for use in web applications built on ASP.NET:
  • Rest Sharp - An open source REST client for .NET

Find out More

Follow @ServiceStack and +ServiceStack for project updates.


Core Team

Contributors

A big thanks to GitHub and all of ServiceStack's contributors:


Runs on both Mono and .NET (Live preview hosted on Mono / Ubuntu)

Something went wrong with that request. Please try again.