nguyetanhmyangel/AdvancedWebAPI

Minimal Web API to advanced data retrieval using pagination, filtering, searching, sorting

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 AdvancedWebAPI

AdvancedWebAPI is a .NET Solution that uses a layer architecture to expose a minimal Web API and to validate advanced data recovery using paging, filtering, searching and sorting.

Web API Service:

getAdvancedPeople Method:

Paging:

Paging Header:

Paging in Postman:

Filtering:

Filtering in Postman:

Searching:

Searching in Postman:

Sorting:

Sorting in Postman:

DTO Schema:

getAllPeople Method:

🛠 Built With

Tech Stack

.NET Core Minimal API,

Server

• Minimal API

Database

• SQL Server

Key Features

• EF Core Database First
• Unit of Work and Repository Patterns
• Services Dependency Injection

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

In order to run this project you need:

• Visual Studio .NET 2022 updated to use NET Core 7
• SQL Server Database

Setup

1. Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/NeckerFree/AdvancedWebAPI

2. Download and restore the Adventure Works Database according to your SQL Server version Adventure Works DB

3. Create a User as db_owner of this batabase

4. Modify the connection string (AdventureWorksConnection) in the file \AWA.MinApi\appsettings.json to point your database

Install

Install this project with:

1. Build the solution and assure that doesn't have errors

2. Set the project AWA.MinApi as default

Usage

To run the project,

• Start the application (F5)

• The /swagger/index.html page is displayed

(back to top)

👥 Authors

👤 Elio Cortés

• GitHub: @NeckerFree
• Twitter: @ElioCortesM
• LinkedIn: elionelsoncortes

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please start my project

(back to top)

🙏 Acknowledgments and references

This project is based on the articles published by Code Maze: Paging Filtering Searching Sorting

(back to top)

❓ FAQ (OPTIONAL)

• What command are required to Scaffold from Scratch a DB First?

  • Run next commands:

    dotnet add AWA.DataAccess package Microsoft.EntityFrameworkCore.Design
    dotnet add AWA.DataAccess package Microsoft.EntityFrameworkCore.SqlServer
  
    dotnet ef dbcontext scaffold "Data Source=.;Initial Catalog=AdventureWorks2017; User Id=XXUser;Password=XXPWD;Encrypt=False" Microsoft.EntityFrameworkCore.SqlServer --project AWA.DataAccess --output-dir "AWA.Models\Models" --context-dir "AWA.DataAccess\Data" --namespace AWA.Models --context-namespace AWA.DataAccess --context AdventureWorksContext -f --no-onconfiguring
    dotnet tool install --global dotnet-ef
    dotnet tool update --global dotnet-ef 
  

• How to Implement Unit Of Work and Generic Repository pattern?

  • Unit Of Work And Generic Repository pattern
  • Repository Pattern and Unit of Work

(back to top)

📝 License

This project is MIT licensed.

MIT license

(back to top)