Skip to content

mbarrett/Piccolo

 
 

Repository files navigation

Piccolo

A modular micro-framework for creating APIs.

Quickstart

1) New web application project (.net 4.0+)
2) Run command Install-Package Piccolo -Pre in Package Manager Console (you will need NuGet v2.6+)
3) New class:

[Route("/")]
public class Hello : IGet<string>
{
	public HttpResponseMessage<string> Get()
	{
		return Response.Success.Ok("Hello, Piccolo!");
	}
}

4) Build and run

Documentation

  1. Installation
  2. GET Request Handlers
  3. POST Request Handlers
  4. PUT Request Handlers
  5. DELETE Request Handlers
  6. Routing
  7. Response Helpers
  8. Events
  9. JSON Serialisation
  10. JSON Deserialisation
  11. Configuration
  12. Advanced Concepts
    1. Start-up Tasks
    2. Implementing Custom Request Handler Factory
    3. Implementing Custom Parameter Binders
    4. Overriding JSON Serialisation
    5. Overriding JSON Deserialisation
    6. High-Level Architecture
  13. Roadmap

License

MIT - see license file for more information

About

A modular micro-framework for creating APIs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 94.2%
  • JavaScript 3.1%
  • PowerShell 2.4%
  • Other 0.3%