Scarecrow.Api 2.0.0

Scarecrow.Api

Overview

A Web API template built on top of Scarecrow.Clean. This template focuses on delivery concerns while keeping business logic isolated. It comes pre-configured with Routing Convention, Logging with Serilog, middleware integration for exception & logging handler, object mapping with Mapperly, and API versioning.

Built On

• Scarecrow.Clean architecture
• ASP.NET Core (.NET 9 & 10)

Features

• Kebab-case routing convention
• Serilog logging
• Exception & request logging middleware
• API versioning
• FluentValidation
• Mapperly
• OpenAPI / Swagger ready

Installation

Install the template from Package Manager console:

Package Manager Console:

dotnet new install Scarecrow.Api

.NET CLI

dotnet new install Scarecrow.Api

When to Use This Template

• ✔ REST APIs
• ✔ Public or internal services
• ✔ HTTP-based integrations

Contributions

Contributions are welcome! If you encounter a bug, have a suggestion, or want to contribute code, please follow these steps:

1. Check the GitHub Issues to see if your issue or idea has already been reported.
2. If not, open a new issue to describe the bug or feature request.
3. For code contributions:
   • Fork the Project repository.
   • Create your Feature Branch (git checkout -b feature/YourAmazingFeature).
   • Commit your Changes (git commit -m 'Add YourAmazingFeature'). Adhere to conventional commit messages if possible.
   • Push to the Branch (git push origin feature/YourAmazingFeature).
   • Open a Pull Request against the main branch of the original repository.
4. Please try to follow the existing coding style and include unit tests for new or modified functionality.

License

Distributed under the MIT License. See the LICENSE file in the repository for more information.

Contact

@muhirwanto-dev

Project link: https://github.com/muhirwanto-dev/scarecrow/tree/main/src/Scarecrow.Api