ModularSystem.Core 1.14.7

ModularSystem Core (under development)

Build a solid basic CRUD within minutes

A library that takes care of the basic and boring stuff about creating web servers. The Modular System seeks to create a simple and modular way to automate the repetitive aspects of creating a regular web application.

Overview

This library is a group of usefull classes for daily delevopment, the goal is to always use the same code abstraction of a concept or idea, that way two diferent servers can communicate without using much, or any, specific adaptation layer. The interface exposed by one server can be parsed and understood without the need to map, type and adapt the data from the output, and that is only possible to do having a stable API model to use, that is what ModularSystem does. The 'Modular' comes from the idea to create specific modules to add functionalities to the application based on this stable interface model; the core library has some modules to add aditional features and code resusability.

CRUD

• Create and insert into database a new instance of a class
• Get one document by ID or or many by search with filters
• Update one document or many with one or multiple updates
• Delete one document by ID

Generic Typing

The entity interface works with a generic type T where T inherts from a base class, that way the library can apply the dynamic CRUD to any class. Some methods are required to be implemented or overriten, that is where the application specific logic can be wired, such as validation and presentation.

Entity Interface

The entity interface is the CRUD foundation, it contains references to all the other interfaces and it wires everything together to create the methods exposed by the entity.

• To start you need to create the data structure that will be the entity model. It is important that this model inherts from the QueryableBase class.

Example:

using ModularSystem.Core;

public class User : QueryableBase
{
    public string Email { get; set; }
    public string Password { get; set; }
}

The QueryableBase adds an Id interface to be used by the rest of the library, so don't forget to do that.

• A presented type for this model is also required, this presented type is what the library will use as external input and output representation of the entity.

Example:

//...
public class PresentedUser 
{
    public string Email { get; set; }
}

Now you are all set to create the entity for this model.

• The entity class must implement the IAppEntity<Data, PresentedData> interface

Example:

using ModularSystem.Core;

public class UserEntity : IAppEntity<User, PresentedUser>
{
    // ...
}

But it is a lot easier to inhert from the AppEntity<Data, PresentedData> class, this way it is not required to implement all the methods from the interface because most of them are already implemented.

using ModularSystem.Core;

public class UserEntity : AppEntity<User, PresentedUser>
{
    // ...
}

Data Access Object Interface (IDAO)

// README NOT FINISHED YET

Example:

using ModularSystem.Core;

public class UserDAO : IDAO<User>
{
    // ...
}