Skip to content

A simple framework to build microservices and apply common best practices

License

Notifications You must be signed in to change notification settings

LittleBlocks/LittleBlocks.API

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LittleBlocks

Release CI

Introduction

LittleBlocks is a set of libraries which facilitate different aspects of a Restful/Microservice api and takes away the boilerplate configuration/bootstrap code that needs to be written each time a new API project is setup. There are up's and down's to this approach, however the benefit of this approach is to setup consistent api projects faster and easier.

Features

Boilerplate api provides the following features:

  • Global Error Handling
  • Preconfigured Logging to a rolling file and log aggregartors such as loggly and seq
  • Application/Common services preregistration within IOC container
  • Request Correlation
  • Preconfigured MVC pipeline
  • FluentValidation framework integration
  • AutoMapper integration with desired IOC container
  • RestEase REST client integration
  • Swagger integration
  • Health endpoint exposed
  • Diagnostics endpoint

For using the full benefit of the library, Create a simple asp.net core project and install EasyApi.AspNetCore.Bootstrap nuget package.

dotnet add package LittleBlocks.AspNetCore.Bootstrap

or
 
Install-Package LittleBlocks.AspNetCore.Bootstrap

In order to achieve all of this functionality you merely need a few lines of code. At this point your Program.cs should look like this:

    public class Program
    {
        public static void Main(string[] args)
        {
            HostAsWeb.Run<Startup>(s =>  s.ConfigureLogger<Startup>());
        }
    }

And startup.cs as follows:

   public class Startup
   {
       public Startup(IConfiguration configuration)
       {
           Configuration = configuration;
       }

       private IConfiguration Configuration { get; }

       public IServiceProvider ConfigureServices(IServiceCollection services)
       {
           return services.BootstrapApp<Startup>(Configuration,
                           app => app
                               .HandleApplicationException<TemplateApiApplicationException>()
                               .AddServices((container, config) => { })
                       );
       }

       public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
       {
           app.UseDefaultApiPipeline(Configuration, env, loggerFactory);
       }
   }

The project/solution is ready to be running in visual studio or using dotnet cli.

More detail information can be found in wiki

About

A simple framework to build microservices and apply common best practices

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 99.5%
  • Other 0.5%