Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 4.35 KB

README.md

File metadata and controls

79 lines (47 loc) · 4.35 KB
Raw

NuGet Badge Build status

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! ⭐

If you like or are using this project to learn or start your solution, please give it a star. Thanks!

Core Technologies

  • Platform: .NET Framework 6.0 - 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

Check the Live Demo 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 Community Edition or higher)

Getting started with EISK Web Api is pretty easy.

You can either clone 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 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:

Questions?

Should you have any questions or need any help to implement new cool features, you can ask in StackOverflow community with tag eisk and get prompt response.