This library aims to provide an easy way in configuring and developing .netcore web api application.

AddEasySharp() & UseEasySharp() must be injected in ConfigureServices & Configure method in the Startup class respectively. Basic Example

• ConfigureServices

  public void ConfigureServices(IServiceCollection services)
  {
      services
          .AddEasySharp();
  }

• Configure

  public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  {
      if (env.IsDevelopment())
          app.UseDeveloperExceptionPage();
      app
          .UseEasySharp();
  }

• EasyDoc
• InputTrimmer
• Cors
• ApiGenericMsg
• XXS
• CQRS
• Validation
• EasyLog
• EfCore
• Caching
• Pagination
• MessageBroker
• EventStore
• Outbox
• Consul

Easy Doc is used for API documentation.

.AddDocs() and .UseDocs() is used to include swagger in the application. Security option can be enable or disabled by passing true or false to IncludeSecurity property.

"SwaggerOptions": {
   "enabled": true,
   "reDocEnabled": false,
   "name": "v1",
   "title": "Example Application",
   "version": ".Net Core 5.0 v1",
   "routePrefix": "docs",
   "Description": "Description here",
   "TermsOfService": "https://example.com/terms",
   "IncludeSecurity": true,
   "SecurityOptions": {
     "xmlDoc": true,
     "apiName": "exampleapi",
     "apiId": "examplecode",
     "tokenUrl": "http://example/AuthServer/connect/token",
     "authorityURL": "http://example/AuthServer/connect/authorize",
     "authority": "http://example/AuthServer",
     "clientSecret": "PeRstRe*$^",
     "issuerUri": "http://example/AuthServer",
     "requireHttpsMetadata": false,
     "Folder": "",
     "filterClassName": "AuthorizeCheckOperationFilter",
     "Contact": {
       "Name": "Michael Ameyaw",
       "Email": "example@gmail.com",
       "Url": "https://www.example.com"
     },
     "License": {
       "Name": "Example Systems Ltd",
       "Url": "http://www.example.com/"
     },
     "Scope": {
       "Name": "scopeapi",
       "Description": "The Scope needed to Access Example Api"
     }
   }
 },

Input Trimmer helps trim model object before saving to db. Available trimers supported :

• InputTrim : Trim all leading and trailing spaces of a string
• LowerTrim : Convert strings to lowercase using the casing rules.

[HttpPost]
[TrimInput]
[LowerInput]
public IActionResult CreateRecord([FromBody] Car model)
{ /* code here */ }

Cross-Origin Resource Sharing is an HTTP-header based mechanism that allows a server to indicate any other origins (domain, scheme, or port) than its own from which a browser should permit loading of resources.

Appsettings for Cors looks like this

"CorsOptions": {
   "Enabled": true,
   "Name": "CorsPolicy",
   "Links": [
     "http://localhost:5000"
   ]
 }

• Enabled is optional and by default is false.
• Name is optional and by default the name is EasySharp.
• Links is only required if Enabled is true and must include uri schema, host and port of the resource server (eg. http://localhost:5000).

AddCorsOption is used in order to include it in your application.

ApiGenericMsg present you with a default message template and better resopnse type. And can easly be used in controllers by calling ApiGenericMsg.OnEntityCreateSuccess<T>(dto, EntityName).

Available CRUD message template are OnEntityCreateSuccess , OnEntityCreateError, OnEntityDeleteSuccess, OnEntityDeleteError, OnEntityUpdateSuccess, OnEntityUpdateError .. etc

 [HttpPost("CreateRecord")]
 public ApiGenericResponse<Car> CreateRecord([FromBody] Car dto) 
     => ApiGenericMsg.OnEntityCreateSuccess(dto, EntityName);

Response type from ApiGenericMessage becomes

{
  "status": 0,
  "data": {
    "brand": "string",
    "model": "string",
    "year": 0
  },
  "message": "string"
}

By default XXS protection is set to false. You can enable it by adding the option below in your app.settings.json file.

 "AntiXssOptions": {
    "Enabled": true
  }

CQRS stands for “Command Query Responsibility Segregation”. As the acronym suggests, it’s all about splitting the responsibility of commands (saves) and queries (reads) into different models. Visit [https://martinfowler.com/bliki/CQRS.html] [CQRS Info] for more infomation

Validation becomes very helpful when there is a need to create/alter records in the database. Easysharp provides fluent validation wrapper & error handling that makes it easy to validate input models. Visit [https://docs.fluentvalidation.net/en/latest/start.html] for more validation rules

   public class CreateCar : AbstractValidator<CreateCarCommand>
    {
        public CreateCar()
        {
            RuleFor(cmd => cmd.Brand).NotEmpty().WithMessage("Please specify Brand");
            RuleFor(cmd => cmd.Model).NotEmpty().WithMessage("Please specify Model");
            RuleFor(cmd => cmd.Year).NotEmpty().WithMessage("Please specify Year");
        }
    }

You can refer to the demo controller for more details.

Easy Log is a logging provider with File Log and Seq Log options. See logging configuration below. UseEasyLog() must be used in Program.cs

By default File logging is set to true.

   "LoggerOptions": {
    "applicationName": "demo-service",
    "excludePaths": [ "/ping", "/metrics" ],
    "level": "information",
    "file": {
      "enabled": true,
      "path": "Logs/logs.txt",
      "interval": "day"
    },
    "seq": {
      "enabled": true,
      "url": "http://localhost:5341",
      "token": "secret"
    }
  }

The only supported Database Driver is Efcore. To enable the driver add AddEfCore() in the startup.cs class, and options below to your ap.settings.json.

"EfCoreOptions": {
    "ConnectionString": "Server=DESKTOP-6BR1LOC;Initial Catalog=Db;user id=sa;password=Password"
},

Choice of caching is set when using AddCacheable() on the IServiceCollection. Supported caching drivers are Redis Caching, In-Memory Caching and File Storage Caching.

Find the app.settings.json configurations below.

"Cacheable": {
    "Redis": {
      "Enable": true,
      "Connection": "localhost:6379",
      "InstanceName": "RedisCacheTestDB"
    },
    "LocalStorage": {
      "Enable": true,
      "AutoLoad": true,
      "AutoSave": true,
      "EnableEncryption": true,
      "EncryptionSalt": "1e69e0a615e8cb813812ca797d75d4f08bdc2f56",
      "EncryptionKey": "password",
      "Folder": "wwwroot\\storage\\disk\\",
      "Filename": ".localstorage"
    }
  }

• Enable Indicates which driver to use.
• AutoLoad Load previously persisted state from disk when set to true
• AutoSave Persist the latest state to disk when set to true
• EnableEncryption Encrypt contents when persisting to disk.
• EncryptionSalt
• EncryptionKey
• Folder Path to where the file should be stored and by default has, wwwroot\\storage\\disk\\
• Filename The name of the file and by default, .localstorage.

Sample Implementation

    
    // Data from Database.
    var collection = EmployeeFactory.Create();

    var key = "storageKey";

    // Save to Memory only.
   _storage.StoreAsync(key, collection);

    // & Save to file.
   _storage.PersistAsync();

Add AddApiPagination() to the IServiceCollection in startup.cs in other to enable easysharp pagination. Inject IUriService in your controller's constructor.

Replace IActionResult in you method definition in the controller to Task<ActionResult<EmployeeDto>>.

Add the following to your method.

 //Prepare Pagination Links
 var route = Request.Path.Value;
 var validFilter = new PaginationFilter(
     filter.PageNumber, 
     filter.PageSize, 
     filter.SearchQuery
 );

 // from db
 var dbResultSet = EmployeeFactory.Create();

 //filter
 var AsQueryableResult = dbResultSet
                        .AsQueryable()
                        .Skip((filter.PageNumber - 1) * filter.PageSize)
                        .Take(filter.PageSize).ToList();


 //Enable search by search filer
 if (!string.IsNullOrEmpty(filter.SearchQuery))
 {
    // trim & ignore casing
    var searchQueryForWhereClause = filter.SearchQuery
        .Trim().ToLowerInvariant();
 
    AsQueryableResult
    .Where(
    o => o.FirstName.ToLowerInvariant().Contains(searchQueryForWhereClause)
    || o.LastName.ToLowerInvariant().Contains(searchQueryForWhereClause))
    .ToList();
  }

    AsQueryableResult.ToList();

    var totalRecords = dbResultSet.Count();
    var pagedData = AsQueryableResult;

    var pagedReponse = PaginationHelper.CreatePagedReponse<EmployeeDto>(
                pagedData, validFilter, totalRecords, _uriService, route
        );
    return Ok(pagedReponse);

Message broker is used to publish and subscribe to events across services. This is to allow services send events to each other.

To enable message brokers all you need to do , is to use .AddMessageBroker() in the Startup.cs IServiceCollection and add the following to the app.settings.json file.

"MessageBrokersOptions": {
    "Enable": true,
    "messageBrokerType": "rabbitmq",
    "username": "guest",
    "password": "guest",
    "virtualHost": "/",
    "port": 5672,
    "hostnames": [
      "localhost"
    ],
    "requestTimeout": "00:00:10",
    "publishConfirmTimeout": "00:00:01",
    "recoveryInterval": "00:00:10",
    "persistentDeliveryMode": true,
    "autoCloseConnection": true,
    "automaticRecovery": true,
    "topologyRecovery": true,
    "exchange": {
      "durable": true,
      "autoDelete": false,
      "type": "fanout",
      "name": "testms"
    },
    "queue": {
      "declare": true,
      "durable": true,
      "exclusive": false,
      "autoDelete": false
    }
  },

In other not to loss any data when publishing to a messasge broker for some reason, it is a good idea to save the event before publishing.

The events are either removed after being published to the message broker or kept with the processed property.

To enable this feature, add AddOutbox() to the IServiceCollection in the Startup.cs.find the configuration below for the app.settings.json fine.

"OutboxOptions": {
    "Enable" :  true,
    "OutboxType": "ef",
    "DeleteAfter": true
  },

You can easly subscribe to event by add the app.UseSubscribeEvent<YourEvent>() to you configure method in the Startup.cs file.

"EventStoresOptions": {
    "Enable": true,
    "EventStoreType": "ef"
  }