Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanskarjaas/ecommerceapp
This project is an eCommerce Web API developed using ASP.NET Web API, C#, and follows a clean architecture with the API, Core, and Infrastructure layers. It utilizes MSSQL for data storage and implements various features like product management, search functionality, pagination, and error handling.
https://github.com/sanskarjaas/ecommerceapp
asp-net-core-web-api entity-framework-core mssql pagination programming-language swagger-ui
Last synced: 9 days ago
JSON representation
This project is an eCommerce Web API developed using ASP.NET Web API, C#, and follows a clean architecture with the API, Core, and Infrastructure layers. It utilizes MSSQL for data storage and implements various features like product management, search functionality, pagination, and error handling.
- Host: GitHub
- URL: https://github.com/sanskarjaas/ecommerceapp
- Owner: Sanskarjaas
- Created: 2023-10-07T08:57:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-07T18:00:23.000Z (3 months ago)
- Last Synced: 2024-12-02T05:15:06.093Z (2 months ago)
- Topics: asp-net-core-web-api, entity-framework-core, mssql, pagination, programming-language, swagger-ui
- Language: C#
- Homepage:
- Size: 1.48 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eCommerce Web API
This project is an eCommerce Web API developed using **ASP.NET Web API**, **C#**, and follows a clean architecture with the **API**, **Core**, and **Infrastructure** layers. It utilizes **MSSQL** for data storage and implements various features like product management, search functionality, pagination, and error handling.
## Features
- **CRUD Operations** for managing product data.
- **Search Functionality** for products by brand, type, and name.
- **Pagination** support to manage large product lists with configurable page size.
- **Error Handling** to provide meaningful error messages and status codes.
- **Swagger** integration for easy API documentation and testing.
- **Repository Pattern** and **Service Layer** for clean architecture.
## Technologies Used
- **ASP.NET Web API** - For building the API endpoints.
- **C#** - Programming language for the API logic.
- **Entity Framework Core** - ORM for data access.
- **MSSQL** - Database to store product data.
- **Swagger** - For API documentation and testing.
- **Repository Pattern** - For data abstraction.
- **Service Layer** - For business logic handling.
## Architecture
The project is organized into three main layers:
### 1. **API Layer**
Contains the API controllers responsible for handling HTTP requests (GET, POST, PUT, DELETE).
### 2. **Core Layer**
Includes business logic, models, and interfaces. This layer defines the application’s core functionality.
### 3. **Infrastructure Layer**
Handles data access using **Entity Framework Core** to interact with the **MSSQL** database and implement the **Repository** pattern.
## Setup and Installation
### Prerequisites
- .NET 6 or higher
- SQL Server (or SQL Express) running locally or on a server
- Visual Studio or Visual Studio Code
### Steps to Run the Project
1. Clone the repository:
```bash
git clone https://github.com/yourusername/ecommerce-web-api.git
cd ecommerce-web-api
```
2. **Configure the Database**:
- Create a new SQL Server database or use an existing one.
- Update the **connection string** in the `appsettings.json` file in the **Infrastructure** project.
3. **Restore NuGet Packages**:
```bash
dotnet restore
4. **Run Migrations **:
dotnet ef database update
Build and Run the API:
5.**Open Swagger at https://localhost:/swagger to interact with and test the API**.
# Query Parameters:
brand: Filter by product brand.
type: Filter by product type.
name: Filter by product name.
page: The page number for pagination.
pageSize: Number of products per page (default is 10).
