Web API Reference Architecture for .NET and ASP.NET Core

This repository contains a reference architecture for building web APIs with .NET and ASP.NET Core.

Getting Started

To get started with the reference architecture, follow these steps:

1. Clone the repository: git clone
2. Open the solution in Visual Studio Code (or your favorite IDE).
3. Read the documentation in the docs folder!

Technologies

• .NET 9: The latest version of the .NET platform.
• ASP.NET Core 9: The latest version of the ASP.NET Core framework.
• Entity Framework Core 5: The latest version of the Entity Framework Core ORM.

Areas of Focus

1. API Design: Designing and building APIs that are easy to use and maintain.

2. Security: Implementing security best practices to protect your APIs.

3. Performance: Optimizing APIs for performance and scalability.

4. Testing: Writing tests to ensure the quality of your APIs.

5. Monitoring: Monitoring APIs to ensure they are healthy and performant.

6. Documentation: Documenting APIs to make them easy to use and understand.

7. Architecture: Designing APIs with a focus on maintainability and scalability. This includes:

   • RESTful Design: Designing APIs with a focus on RESTful principles.
   • Domain-Driven Design: Designing APIs with a focus on the domain model.
   • Clean Architecture: Designing APIs with a focus on separation of concerns.
   • Vertical Slice Architecture: Designing APIs with a focus on feature slices.
   • CQRS: Designing APIs with a focus on command and query separation.
   • Event Sourcing: Designing APIs with a focus on event sourcing.

Contributing

If you would like to contribute to the reference architecture, please read the contribution guidelines.

License

This reference architecture is licensed under the MIT License.