Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/EISK/eisk.webapi

Project based on latest .NET (v6.0) technologies for building scalable web api, along with clean architecture patterns.
https://github.com/EISK/eisk.webapi

api asp-net-core aspnet aspnet-core aspnet-web-api aspnet6 aspnetcore aspnetwebapi azure c-sharp dotnet dotnet6 ef6 entity-framework entity-framework-core vs2022 web-api webapi webapi-sample

Last synced: 8 days ago
JSON representation

Project based on latest .NET (v6.0) technologies for building scalable web api, along with clean architecture patterns.

Host: GitHub
URL: https://github.com/EISK/eisk.webapi
Owner: EISK
License: mit
Created: 2019-01-05T08:23:40.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-09-30T11:57:33.000Z (about 1 year ago)
Last Synced: 2024-08-01T05:12:12.331Z (3 months ago)
Topics: api, asp-net-core, aspnet, aspnet-core, aspnet-web-api, aspnet6, aspnetcore, aspnetwebapi, azure, c-sharp, dotnet, dotnet6, ef6, entity-framework, entity-framework-core, vs2022, web-api, webapi, webapi-sample
Language: C#
Homepage: https://eisk.github.io
Size: 15.7 MB
Stars: 220
Watchers: 15
Forks: 56
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-dotnet-core - EISK - Provides developer resources with simple use cases to build scalable applications on top of .NET Core with [architectural best practices](https://docs.microsoft.com/en-us/dotnet/standard/modern-web-apps-azure-architecture/common-web-application-architectures) (DDD, onion architecture etc) (Frameworks, Libraries and Tools / Application Templates)
awesome-starred-test - EISK/eisk.webapi - Project based on latest .NET (v6.0) technologies for building scalable web api, along with clean architecture patterns. (C# #)
fucking-awesome-dotnet-core - EISK - Provides developer resources with simple use cases to build scalable applications on top of .NET Core with 🌎 [architectural best practices](docs.microsoft.com/en-us/dotnet/standard/modern-web-apps-azure-architecture/common-web-application-architectures) (DDD, onion architecture etc) (Frameworks, Libraries and Tools / Application Templates)
awesome-dotnet-core - EISK - Provides developer resources with simple use cases to build scalable applications on top of .NET Core with [architectural best practices](https://docs.microsoft.com/en-us/dotnet/standard/modern-web-apps-azure-architecture/common-web-application-architectures) (DDD, onion architecture etc) (Frameworks, Libraries and Tools / Application Templates)
awesome-dotnet-core - EISK - 为开发人员资源提供简单的用例，以使用[体系结构最佳实践]在.NET Core之上构建可伸缩的应用程序 (DDD, onion architecture etc) (框架, 库和工具 / 应用程序模板)

README

[![NuGet Badge](https://buildstats.info/nuget/Eisk.WebApi)](https://www.nuget.org/packages/Eisk.WebApi/) [![Build status](https://dev.azure.com/EiskOps/Eisk/_apis/build/status/Eisk-WebApi-TemplatePack-CI)](https://dev.azure.com/EiskOps/Eisk/_build/latest?definitionId=3)

EISK makes it easy to write scalable and secured web api on top of Microsoft's new cutting edge .net based technologies.

With an optional set of customizable utility classes, samples and tools, it lets you creating new web api straight away without wide technical experience or learning curve.

## Give a Star! :star:

If you like or are using this project to learn or start your solution, please give it a [star](https://github.com/EISK/eisk.webapi). Thanks!

## Core Technologies

* Platform: [.NET Framework 6.0](https://devblogs.microsoft.com/dotnet/announcing-net-6/) - The Fastest .NET Yet!
* Web Framework: ASP.NET Web API
* ORM Framework: Entity Framework
* Programming Language: C#

## Sample Use Case

Using a simple data entity 'Employee', EISK shows how we can build scalable web api's easily along with addressing real-world domain and business use cases, including:

* [C]reating a new employee record
* [R]ead existing employee records
* [U]pdate an existing employee record
* [D]elete an existing employee record

![eisk web api](https://raw.githubusercontent.com/EISK/eisk.docs/master/content/art/intro/eisk-v9-webapi.png)

Check the [Live Demo](https://eisk-webapi.azurewebsites.net) to see the use case implementation in action.

## Dev Features

You can build your own RESTful web api using EISK's Visual Studio and ASP.NET Web API project template.

The template includes (but not limited to), project structure and all utility classes mentioned below to enable building modern cloud-aware RESTful APIs.

* **Clean Architecture** based implementation
* **Swagger/OpenAPI** based RESTful Web API specification
* **Base classes** for common CRUD functionalities and testing for logical layers (i.e. controller, domain, data layers)
* **Utility classes** to generate real-world test data
* Support for database integration tests with both in-memory database and SQL server

## QuickStart Guide

Before installing EISK, all you need to have the following Visual Studio version installed.

* Visual Studio 2022 ([Free](https://visualstudio.microsoft.com/vs/community/) Community Edition or higher)

Getting started with EISK Web Api is pretty easy.

You can either [clone](https://github.com/EISK/eisk.webapi.git) from github or simply run the following `dotnet new` command in command prompt to create a new project from EISK:

* Command to install EISK template in your machine: `dotnet new --install Eisk.WebApi`
* Command to create a new project: `dotnet new eiskwebapi -n Eisk`

Once the contents are available, just open the created solution, select "Eisk.WebApi" as startup project and press F5!

That's it!

### How About Older Versions?

If you want to continue using one of the older versions of EISK, check the [releases](https://github.com/EISK/eisk.webapi/releases) page for specific instructions to install and use older versions of EISK.

## What's Next?

After running the created project successfully, you'll get an understanding about how the sample use case has been used to explore cutting edge technologies for building a web api.

Next - you can try some hands-on experience by creating your own api on top of your custom entity and see how quickly you can roll out an enterprise quality web api with similar quality and productivity.

Utilities and code samples as provided in EISK have intentionally been designed to be self explaining. You may still want to get deeper understanding by exploring the documentations:

* [Live Demo](https://eisk-webapi.azurewebsites.net)
* [Hands-on Walk-through](https://eisk.github.io/docs/webapi/application-development/handson-walkthrough-create-service-api.html)
* [Logical Layer Architecture](https://eisk.github.io/docs/webapi/architecture/logical-layers.html)
* [Technology Stack](https://eisk.github.io/docs/webapi/technical-reference/technology-stack.html)

## Questions?

Should you have any questions or need any help to implement new cool features, you can [ask](https://stackoverflow.com/questions/ask?tags=eisk,webapi,asp.net-core&title=In%20EISK,%20How%20Do%20We%20..) in StackOverflow community with tag [eisk](https://stackoverflow.com/questions/tagged/eisk) and get prompt response.