This project is an example of implementing Clean Architecture in a Web API using ASP.NET Core. It is a starting point for building ASP.NET Core Web API applications following Clean Architecture principles. It aims to provide a well-defined project structure that separates concerns into different layers, making the application easier to manage, develop, and test.
If you find this project useful helpful as a starting template in implementing Clean Architecture in ASP.NET Core, please give it a star, on GitHub to help others developers discover it! Thanks
-Introduction to Clean Architecture
Clean Architecture is a software design philosophy that separates the elements of a project into ringed levels, promoting the independence of system components. This approach ensures that the system is easy to maintain and evolve, particularly in complex applications with extensive business rules.
At the heart of Clean Architecture is the principle of dependency inversion. Dependencies flow from the outer layers (mechanisms such as UI, frameworks, and tools) towards the inner layers (policies like Entities and Use Cases), ensuring that the core business logic remains independent of external frameworks and technology. This separation of concerns makes the system more flexible and adaptable to changes in technology or business requirements.
- Clean Architecture based on Domain-Driven Design principles
- Use of Entity Framework Core for data access
- Swagger/OpenAPI for API documentation
- Unit and Integration Tests
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
Before you begin, ensure you have the following installed:
- .NET SDK (Version .Net 8)
- An IDE of your choice (e.g., Visual Studio, VS Code)
-
Clone the repository:
git clone https://github.com/ulomaramma/clean-architecture.git
-
Navigate to the project directory:
cd clean-architecture -
Install dependencies:
dotnet restore
-
Update the database connection string in appsettings.json within the Presentation Layer project.
-
Apply the migrations to your database:
dotnet ef database update
-
Run the Application
dotnet run
Clean Architecture is centered around the Domain and Application layers, promoting loose coupling and separation of concerns. This project is structured as follows:
Domain Layer: Contains all entities, enums, exceptions, interfaces, types, and logic specific to the domain problem this project is solving.
Application Layer: Houses the application logic and defines the interfaces that are implemented by the outside layers. Depends on the domain layer but has no dependencies on any other layer or project.
Infrastructure Layer: Implements external concerns such as database access, file system access, network calls, etc.
Presentation Layer: In this case, the ASP.NET Core Web API, responsible for delivering HTTP responses to the client, parsing requests, and handing them off to the application layer for processing.
Overview of the Project Structure is shown below
After running the application, navigate to http://localhost:Port/swagger to see the API documentation and test the endpoints.
We welcome contributions! If you'd like to improve the guide, add examples, or correct any mistakes, please feel free to fork the repository and submit a pull request.
Fork the repository.
- Create a new branch for your feature (git checkout -b feature/NewFeature).
- Commit your changes (git commit -am 'Add some NewFeature').
- Push to the branch (git push origin feature/NewFeature).
- Open a Pull Request
Thank you for checking out this guide. Don't forget to star the project if it helped you!