Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lbotinelly/zen
Opensource, zero-setup database-agnostic .Net Core middleware
https://github.com/lbotinelly/zen
ioc net-core net-core-3 orm rest-api
Last synced: 4 days ago
JSON representation
Opensource, zero-setup database-agnostic .Net Core middleware
- Host: GitHub
- URL: https://github.com/lbotinelly/zen
- Owner: lbotinelly
- License: mit
- Created: 2019-05-16T01:11:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T20:28:56.000Z (8 months ago)
- Last Synced: 2024-05-16T13:40:35.675Z (7 months ago)
- Topics: ioc, net-core, net-core-3, orm, rest-api
- Language: C#
- Homepage:
- Size: 2.76 MB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Zen is platform-independent .NET Core middleware that simplifies the implementation of data-driven, API-focused apps.
## Oh, c'mon! Yet another do-it-all framework? Really?
Not quite. Zen provides several features like ORM, caching, encryption and RESTful endpoints out of the box with zero setup in most cases. Think of it like a drop-in middleware that'll get your PoC app working with persistent storage to REST endpoints in no time and with minimal scaffolding - and you can add more features as the need arises.
Its core aspect is the ability to handle data for multiple connectors at the same time, regardless of the target database: Both relational and document (no-SQL) models are supported. Pull data from Oracle and write to Mongo, this kind of stuff.
## Something basic: a database-backed console app
To have it working straight out of the box we need `Zen.Base` (the ORM handler) and a database adapter; let's pick `Zen.Module.Data.LiteDB` for this example.
- [📦 Zen.Base](https://www.nuget.org/packages/Zen.Base/)
- [📦 Zen.Module.Data.LiteDB](https://www.nuget.org/packages/Zen.Module.Data.LiteDB/)
Extremely complicated example ahead. Pay attention!
- Create a class that inherits from the `Zen.Base.Module.Data<>` generic class;
- Mark the property you want to use as a unique identifier with the [Key] Data Annotation attribute.
C# example:
using System.ComponentModel.DataAnnotations;
using System;
using Zen.Base.Module;
namespace Test
{
public class Person : Data
{
[Key]
public string Id { get; set; }
public string Name { get; set; }
}
}
## W-wait, what have I just done?
Congratulations! You created a LiteDB-backed ORM class. A default database was created, together with a collection to store entries.
## You mentioned something about REST
Oh, REST! Right. So, once you decide you want to expose your ORM class data through a REST endpoint, do this:
- Add a reference to [📦 Zen.Web](https://www.nuget.org/packages/Zen.Web/)
- Add Zen to the Service collection and configure it with the Application builder:
```
using Zen.Base.Service.Extensions;
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{ services.AddZen(); }
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{ app.UseZen(); }
}
```
- Use the simplified Builder:
```
using Zen.Web.Host;
namespace Sample
{
public class Program
{
public static void Main(string[] args)
{ Builder.Start(args); }
}
}
```
- Implement a class deriving from `Zen.Web.Data.Controller.DataController<>`, and assign a route to it:
```
[Route("api/people")]
public class PersonController : DataController {}
```
- ...and that's it.
`DataController<>` implements standard REST operations (`GET`, `GET/{ID}`, `POST`, `DELETE`, `PATCH`) as well as some useful extentions (e.g. `GET/new`). These can be expanded by modules that offer functionalities like moderation and set versioning.
Now run your project, and reach the endpoint you specified. If you're running the sample provided (`Sample02-REST`), you can try the following URLs:
- **`https://localhost:5001/api/people`**
```
[{"Id":"1","Name":"Halie","LastName":"Ebert","Email":"[email protected]"},{"Id":"2","Name":"Meta","LastName":"Mayert","Email":"[email protected]"},{"Id":"3","Name":"Deonte","LastName":"Orn","Email":"[email protected]"},,(...)
```
- **`https://localhost:5001/api/people/1`**
```
{"Id":"1","Name":"Halie","LastName":"Ebert","Email":"[email protected]"}
```
- **`https://localhost:5001/api/people/new`**
```
{"Id":"fc8dbb27-42fe-45db-be09-18a84361d509","Name":null,"LastName":null,"Email":null}
```
## Core dependencies
The relational Data module wraps around [Stack Exchange Dapper](https://github.com/StackExchange/dapper-dot-net), an abusively fast IDbConnection interface extender.
## Zen Development Team
- [Leo Botinelly](https://www.linkedin.com/in/lbotinelly) (http://pt.stackoverflow.com/users/1897/onosendai)
## License
MIT - a permissive free software license originating at the Massachusetts Institute of Technology (MIT), it puts only very limited restriction on reuse and has, therefore, an excellent license compatibility. It permits reuse within proprietary software provided that all copies of the licensed software include a copy of the MIT License terms and the copyright notice.
Check the [LICENSE file](LICENSE.txt) for more details.