Core api template

Core api template is designed to be a quick way to create a new api project that has a reasonable separation of data and logic layers without any of the hassle. If you're looking to explore specific patterns, designs or implementations this may provide a core system for you to work off instead of having to create a new project from scratch and lose interest by the time you've reached the exploration state.

It's a work in progress so expect to see things change as it's improved and optimized.

There's a few limitations to be aware of:

• There is alot of reflection in the project BaseSqlDataContext & DataServiceInjection being the biggest examples. BaseSqlDataContext uses reflection to construct sql queries from classes and must data queries will end up using it so keep that in mind.
• Where data is to be persisted, there needs to be a model and a data class which is okay for the project's intended use but may get cumbersome over time but to get around this SqlDataAttribute can be used on the model class.
• Alot of services are singleton given it's only ever going to be local development

Persistence

The idea of this is to have an easy way to communicate with a database without having to write the sql directly and have a degree of separation for unit testing without having to do much work.

Base sql data context

BaseSqlDataContext.cs implements all members of IDataContext<T> so inheriting this into a data class should give you core SQL functionality. The idea is that in complex data tables the base implementations can be overridden to meet the requirements but most of the time BaseSqlDataContext will have you covered and creating a new model is about the same effort as using EF but without the complications.

Data context factory

DataContextFactory.cs will provide you with the relevant IDataContext implementation, or you could just inject the implementations you want. This works alongside DataServiceInjection which will use reflection to find all of the IDataContext implementations - Again this is really to save time and make creating a new model as easy as possible.

Data service injection

DataServiceInjection.cs will during startup use reflection to register all services that are an implementation of IDataContext<T> to make creating a new model as easy as possible.

Data classes

A new model can be created by two methods:

1. A new class implementing IDataContext<T> which defines most core interactions with persisting data. You can also inherit base contexts that implement most/all the methods for the data class to work. The reason i've not made it part of the interface is because i have an intention to not limit the persistence to sql services therefore the base can be interchanged.

2. Using SqlDataAttribute on the model for data structures that don't require any overrides for their implementation. This will create a generic class implementing IDataContext<T> for you to reduce the overhead further

Future work

Check out the project page. I can't make any promises on how long this will be maintained for!