Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/phanxuanquang/asp.net-core-web-api-with-orm

The template to setup a backend server using Entity Framework and XML Documentation, bypassing CORS policies, restructuring API response format, and customizing message for standard HTTP status codes
https://github.com/phanxuanquang/asp.net-core-web-api-with-orm

api asp-net-core backend cors csharp dotnet entity-framework entity-framework-core mssql npgsql orm postgresql sql sqlite sqlserver swagger template visual-studio

Last synced: 29 days ago
JSON representation

The template to setup a backend server using Entity Framework and XML Documentation, bypassing CORS policies, restructuring API response format, and customizing message for standard HTTP status codes

Host: GitHub
URL: https://github.com/phanxuanquang/asp.net-core-web-api-with-orm
Owner: phanxuanquang
Created: 2024-04-15T14:16:20.000Z (9 months ago)
Default Branch: master
Last Pushed: 2024-04-19T16:16:19.000Z (9 months ago)
Last Synced: 2024-10-11T19:24:34.796Z (3 months ago)
Topics: api, asp-net-core, backend, cors, csharp, dotnet, entity-framework, entity-framework-core, mssql, npgsql, orm, postgresql, sql, sqlite, sqlserver, swagger, template, visual-studio
Language: C#
Homepage:
Size: 54.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

![image](https://i.imgur.com/PcgT383.png)
This project template tailored for backend development using C# .NET. Whether you're a newcomer to backend development or an experienced developer looking for a streamlined setup, this template provides a solid foundation to kickstart your project.

Now that you have a solid foundation, feel free to explore and extend the template to suit your project requirements. Whether you're building a small-scale application or a large-scale enterprise solution, this template provides a robust starting point for your backend development journey.

## 🎯 Target Audience:
- **Newcomers to Backend Development:** Get up and running quickly with a project that's ready to run out of the box.
- **C# .NET Developers:** Utilize the latest features of .NET 8 for efficient backend development.
- **Database Enthusiasts:** Connect seamlessly to popular SQL databases like SQL Server, PostgreSQL, and SQLite.
- **API Development with ORM:** Implement Object-Relational Mapping (ORM) techniques effortlessly using Entity Framework.
- **Minimal Configuration:** Minimize setup time and focus on coding with pre-configured settings.

## 🚀 Pre-configured features
- Standardized connection strings for SQL databases ensure smooth integration.
- Automatic database connection checks before server initialization.
- CORS policies are pre-configured to prevent blocking when accessing APIs from different origins.
- Integrated Swagger UI with pre-configured XML documentation for clear API documentation and exploration.
- Filters in place to structure API responses and provide meaningful error messages, enhancing client-side handling.
- Newtonsoft.Json NuGet package is included for efficient JSON serialization and deserialization.
- Provision of examples for standard SQL table schema creation, model definition, and DbContext declaration.

## ⚒️ Prerequisites
- Visual Studio 2019 or above
- [**.NET 8 SDK**](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) installed
- [**ASP.NET and web development**](https://dotnet.microsoft.com/en-us/learn/aspnet/blazor-tutorial/install) workload installed
- [**SQL Server**](https://www.microsoft.com/en-us/sql-server/sql-server-downloads) and [**SQL Server Management Studio**](https://aka.ms/ssmsfullsetup) if you use SQL Server database
- [**PostgreSQL**](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads) and [**pgAdmin 4**](https://www.pgadmin.org/download/pgadmin-4-windows/) if you use PostgreSQL database
- A `.db` file saved from [**SQL Online IDE**](https://sqliteonline.com/) if you use SQLite database

## 📚 Usage Guidance
*In this guidance, I take SQL server as the example for database connection*.
### Step 1: Download and install
- Download the template [**HERE**](https://github.com/phanxuanquang/ASP.NET-Core-Web-API-with-ORM/releases/download/1.0.0/ASP.NET.Core.Web.API.with.Entity.Framework.zip) but do not extract the package after downloading
- Place the template in the following folder. The folder name may vary depending on your Visual Studio version.
```console
...\Document\Visual Studio 2022\Templates\ProjectTemplates
```
![image](https://i.imgur.com/9ufsemT.png)

### Step 2: Setup connection with database
- In the [`appsettings.json`](https://github.com/phanxuanquang/ASP.NET-Core-Web-API-with-ORM/blob/master/ASP.NET%20Core%20Web%20API%20with%20Entity%20Framework/appsettings.json) file, input information for the connection string. You only need to input the information for the database that you want to use.
![image](https://i.imgur.com/zRIQ0rE.png)
- In the [`DatabaseConnectionChecking.cs`](https://github.com/phanxuanquang/ASP.NET-Core-Web-API-with-ORM/blob/master/ASP.NET%20Core%20Web%20API%20with%20Entity%20Framework/Middlewares/DatabaseConnectionChecking.cs) file, input the type of your SQL database. Specify your SQL database type by modifying SqlServer to the desired database (SqlServer, Sqlite, or Npgsql).
![image](https://i.imgur.com/ooobHmy.png)
- In the **NuGet Package Manager**, find and install the NuGet package coresponding to your database type which is mentioned in `Program.cs` file
![image](https://i.imgur.com/uF5w5z7.png)
- In the [`Program.cs`](https://github.com/phanxuanquang/ASP.NET-Core-Web-API-with-ORM/blob/master/ASP.NET%20Core%20Web%20API%20with%20Entity%20Framework/Program.cs) file, enable only your database type by removing the Comment remark
![image](https://i.imgur.com/RUDU39s.png)

### Step 3: Make it yours
- Create the models and controllers as needed
![image](https://i.imgur.com/xXN8WxL.png)
- Register your models in the [`ApiDbContext.cs`](https://github.com/phanxuanquang/ASP.NET-Core-Web-API-with-ORM/blob/master/ASP.NET%20Core%20Web%20API%20with%20Entity%20Framework/API%20Handler/ApiDbContext.cs) file
![image](https://i.imgur.com/Krbaurp.png)
- Optionally apply the provided filters to your controller classes.
![image](https://i.imgur.com/xON8Uny.png)

## 4. Additional Notes:
- The template is pre-configured for SQL Server; consider PostgreSQL for large-scale projects with extensive datasets and SQLite for smaller projects with simpler database schemas.
- Tailor the template to your specific project requirements and database preferences.