The purpose of this template is to provide a robust and streamlined methodology for enterprise application development. By capitalizing on the strengths of Clean Architecture and ASP.NET Core, it ensures a maintainable, scalable, and efficient development process. This approach not only simplifies the complexity of enterprise systems but also enhances their performance and longevity.
The following prerequisites are required to build and run the solution:
- .NET 9.0 SDK (latest version)
The easiest way to get started is to install the .NET template:
dotnet new install Sam.CleanArchitecture.Template
You should see the template in the list of templates from dotnet new list after this installs successfully. Look for "ASP.NET Clean Architecture Solution" with Short Name of "ca-api".
Navigate to the parent directory in which you'd like the solution's folder to be created.
Run this command to create the CleanArchitecture project
dotnet new ca-api -n MyProjectNameThe MyProjectName directory and solution file will be created, and inside that will be all of your new solution contents, properly namespaced and ready to run/test!
- Create new UseCase
- Create New Entity
- Create New Resource
- Easy Add Migration Tools
- Configure Database
Download the Extension and install it on your machine. Make sure Visual Studio 2022 is installed on your machine with the latest SDK.
Follow these Steps to get started.
You Solution Template is Ready!
Next, open the appsettings.json file in WebAPI to modify the ConnectionStrings if necessary.
Finally, build and run the Application.
As soon you build and run your application, default users and roles get added to the database.
Default Roles are as follows.
- Admin
Here are the credentials for the default users.
- UserName - Admin / Password - Sam@12345
You can use these default credentials to generate valid JWTokens at the ../api/v1/Account/Authenticate endpoint.
Does it really make sense to Setup your ASP.NET Core Solution everytime you start a new WebApi Project ? Aren't we wasting quite a lot of time in doing this over and over gain?
This is the exact Problem that I intend to solve with this Full-Fledged ASP.NET Core 9 WebApi Solution Template, that also follows various principles of Clean Architecture.
The primary goal is to create a Full-Fledged implementation, that is well documented along with the steps taken to build this Solution from Scratch. This Solution Template will also be available within Visual Studio 2022 (by installing the required Nuget Package / Extension).
Demonstrate Clean Monolith Architecture in ASP.NET Core 9
- This is not a Proof of Concept
- Implementation that is ready for Production
- Integrate the most essential libraries and packages
To streamline your development process and simplify project management for Clean Architecture, we've introduced a complementary tool: Clean Architecture Assistant.
While the Clean Architecture Template enables you to kickstart your projects with a solid architecture, Clean Architecture Assistant takes your development workflow to the next level.
- Quick Use Case Creation: Generate use case classes and interfaces with a single click, following Clean Architecture patterns.
- Entity Management: Create and manage entities effortlessly, adhering to best practices.
- Repository Integration: Add repositories with pre-configured templates to save time and standardize your approach.
- Migration Management: Simplify database updates by managing migrations directly from Visual Studio.
- Multi-Language Support: Seamlessly add new languages to your project.
By combining the power of the Clean Architecture Template with the Clean Architecture Assistant, you can save valuable development time, reduce repetitive tasks, and maintain a consistent architecture across your project.
To see the frequently asked questions and find answers related to using and developing the project, please refer to the FAQ file. This file includes common questions you might encounter while working with the project and provides links to the relevant documentation.
If you found this Implementation helpful or used it in your Projects, do give it a star. Thanks!
- ASP.NET Core 9 WebApi
- REST Standards
- Clean Architecture
- CQRS with MediatR Library
- Entity Framework Core - Code First
- Repository Pattern - Generic
- Serilog
- Swagger UI
- Response Wrappers
- Healthchecks
- Pagination
- Microsoft Identity with JWT Authentication
- Role based Authorization
- Identity Seeding
- Database Seeding
- Custom Exception Handling Middlewares
- API Versioning
- Localization (fa / en)
- Fluent Validation
- Complete User Management Module (Register / Authenticate / Change UserName / Change Password)
- User Auditing
- TestProjects
- Visual Studio 2022 Community and above
- .NET Core 9 SDK and above
- Basic Understanding of Architectures and Clean Code Principles
I have personally not come across a clean implementation on a WebAPI, which is the reason that I started building this up. There are quite a lot of improvements and fixes along the way from the day I started out. Thanks to the community for the support and suggestions. Please share this Repository within your developer community, if you think that this would a difference! Thanks.
- Twitter - Saman Azadi
- Linkedin - Saman Azadi
- Github - Saman Azadi
