Lightweight, low-ceremony, framework for building HTTP based services on .Net and Mono
C# JavaScript HTML Liquid Ruby CSS Other
Permalink
Failed to load latest commit information.
.github Fixes wording on the pull request template May 11, 2016
samples upgrade Microsoft.NETCore.App to 1.0.1 Oct 19, 2016
src Khellang fixes bootstrapper resolution error Nov 25, 2016
test Attempt at fixing Travis build Nov 21, 2016
tools Removed docu and mspec from tools folder Mar 8, 2016
.editorconfig Added .editorconfig Aug 26, 2015
.gitattributes Settings the stage for magic Nov 20, 2010
.gitignore Upgraded dotnet cli tools to preview 2 for RTM build Jul 8, 2016
.mailmap Added .mailmap Aug 25, 2015
.travis.yml Update .travis.yml Nov 21, 2016
Gemfile include the rake gem Jun 8, 2015
Nancy.Next.sln added kestrel demo project May 27, 2016
Nancy.Next.sln.DotSettings Add ReSharper code style for braces (#2480) Jun 3, 2016
Nancy.ruleset Add code analysis including async rules Oct 31, 2016
Nancy.sln Moved samples projects back into old folders Feb 5, 2016
Nancy.sln.DotSettings Add ReSharper code style for braces (#2480) Jun 3, 2016
NuGet.config Updated to stable rc2 bits May 27, 2016
README.md Updated README.md Nov 16, 2016
SharedAssemblyInfo.cs Updated SharedAssemblyInfo to v2.0.0-alpha Mar 22, 2016
appveyor.yml Update appveyor.yml Oct 21, 2016
build.cake Updated to SDK 1.0.0-preview2-003131 and upgraded build scripts Oct 21, 2016
build.ps1 Updated CAKE to 0.17.0 Dec 1, 2016
build.sh Updated CAKE to 0.17.0 Dec 1, 2016
customassemblyinfo.rb Added new task for updating informational version Feb 4, 2013
favicon.license.txt corrected typo in license owner Apr 24, 2015
global.json Updated to SDK 1.0.0-preview2-003131 and upgraded build scripts Oct 21, 2016
how_to_build.txt Updated to SDK 1.0.0-preview2-003131 and upgraded build scripts Oct 21, 2016
license.txt Updated readme and license to include Steven Robbins as core developer Mar 31, 2011
rakefile.rb Made the compile tasks depend on the nuget restore tasks Mar 17, 2016
sub_projects.rb Added placeholder script for future subproject refactor Nov 2, 2011

README.md

Meet Nancy NuGet Version Slack Status

Nancy is a lightweight, low-ceremony, framework for building HTTP based services on .NET Framework/Core and Mono. The goal of the framework is to stay out of the way as much as possible and provide a super-duper-happy-path to all interactions.

Nancy is designed to handle DELETE, GET, HEAD, OPTIONS, POST, PUT and PATCH requests and provides a simple, elegant, Domain Specific Language (DSL) for returning a response with just a couple of keystrokes, leaving you with more time to focus on the important bits.. your code and your application.

Write your application

public class Module : NancyModule
{
    public Module()
    {
        Get("/greet/{name}", x => {
            return string.Concat("Hello ", x.name);
        });
    }
}

Compile, run and enjoy the simple, elegant design!

Features

  • Built from the bottom up, not simply a DSL on top of an existing framework. Removing limitations and feature hacks of an underlying framework, as well as the need to reference more assemblies than you need. keep it light
  • Run anywhere. Nancy is not built on any specific hosting technology can be run anywhere. Out of the box, Nancy supports running on ASP.NET/IIS, WCF, Self-hosting and any OWIN
  • Ultra lightweight action declarations for GET, HEAD, PUT, POST, DELETE, OPTIONS and PATCH requests
  • View engine integration (Razor, Spark, dotLiquid, our own SuperSimpleViewEngine and many more)
  • Powerful request path matching that includes advanced parameter capabilities. The path matching strategy can be replaced with custom implementations to fit your exact needs
  • Easy response syntax, enabling you to return things like int, string, HttpStatusCode and Action elements without having to explicitly cast or wrap your response - you just return it and Nancy will do the work for you
  • A powerful, light-weight, testing framework to help you verify the behavior of your application
  • Content negotiation
  • And much, much more

The super-duper-happy-path

The "super-duper-happy-path" (or SDHP if you’re ‘down with the kids’ ;-)) is a phrase we coined to describe the ethos of Nancy; and providing the “super-duper-happy-path” experience is something we strive for in all of our APIs.

While it’s hard to pin down exactly what it is, it’s a very emotive term after all, but the basic ideas behind it are:

  • “It just works” - you should be able to pick things up and use them without any mucking about. Added a new module? That’s automatically discovered for you. Brought in a new View Engine? All wired up and ready to go without you having to do anything else. Even if you add a new dependency to your module, by default we’ll locate that and inject it for you - no configuration required.
  • “Easily customisable” - even though “it just works”, there shouldn’t be any barriers that get in the way of customisation should you want to work the way you want to work with the components that you want to use. Want to use another container? No problem! Want to tweak the way routes are selected? Go ahead! Through our bootstrapper approach all of these things should be a piece of cake.
  • “Low ceremony” - the amount of “Nancy code” you should need in your application should be minimal. The important part of any Nancy application is your code - our code should get out of your way and let you get on with building awesome applications. As a testament to this it’s actually possible to fit a functional Nancy application into a single Tweet :-)
  • “Low friction” - when building software with Nancy the APIs should help you get where you want to go, rather than getting in your way. Naming should be obvious, required configuration should be minimal, but power and extensibility should still be there when you need it.

Above all, creating an application with Nancy should be a pleasure, and hopefully fun! But without sacrificing the power or extensibility that you may need as your application grows.

Community

Nancy followers can be found on Slack NancyFx team. You can also find Nancy on Twitter using the #NancyFx hashtag.

Help out

There are many ways you can contribute to Nancy. Like most open-source software projects, contributing code is just one of many outlets where you can help improve. Some of the things that you could help out with in Nancy are:

  • Documentation (both code and features)
  • Bug reports
  • Bug fixes
  • Feature requests
  • Feature implementations
  • Test coverage
  • Code quality
  • Sample applications

Continuous integration builds

Platform Status
AppVeyor (.NET & .NET Core) Build Status
Travis (Mono) Build Status

To get build artifacts of latest master, please use our MyGet feed

Contributors

Nancy is not a one man project and many of the features that are available would not have been possible without the awesome contributions from the community!

For a full list of contributors, please see the website.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Contribution License Agreement

Contributing to Nancy requires you to sign a contribution license agreement (CLA) for anything other than a trivial change. By signing the contribution license agreement, the community is free to use your contribution to .NET Foundation projects.

.NET Foundation

This project is supported by the .NET Foundation.

Copyright

Copyright © 2010 Andreas Håkansson, Steven Robbins and contributors

License

Nancy is licensed under MIT. Refer to license.txt for more information.