gRPC CRUD Boilerplate

A modern .NET 8.0 boilerplate for building production-ready gRPC services with REST API support through HTTP/JSON transcoding.

Features

• 🔐 Authentication & Authorization

  • JWT-based authentication
  • Role-based access control
  • Permission-based authorization
  • Refresh token support
  • Argon2 password hashing

• 🛠 API Features

  • gRPC services with HTTP/JSON transcoding
  • Swagger/OpenAPI documentation
  • Both unary and streaming operations
  • Correlation ID tracking
  • Exception handling middleware
  • Input validation

• 📊 Data Management

  • Entity Framework Core with in-memory database
  • AutoMapper for object mapping
  • CSV import/export functionality
  • Streaming support for large datasets

• 📝 Logging & Monitoring

  • Structured logging with Serilog
  • Console and file logging
  • Request/response logging
  • Performance monitoring

Prerequisites

• .NET 8.0 SDK
• Visual Studio 2022, VS Code, or Rider

Getting Started

1. Clone the repository:

git clone https://github.com/yourusername/grpc-crud-boilerplate.git
cd grpc-crud-boilerplate

2. Run the application:

dotnet run

3. Access the Swagger UI:

• HTTP: http://localhost:5000/swagger
• HTTPS: https://localhost:5001/swagger

Project Structure

├── Contracts/              # DTOs and contracts
├── DataContext/           
│   ├── Entities/          # Domain entities
│   └── SeedInitialData.cs # Initial seed data
├── GrpcServices/          
│   └── v1/               # gRPC service implementations
├── Infrastructure/        
│   ├── Authorization/    # Authorization components
│   └── Exception/        # Exception handling
├── Mappings/             # AutoMapper profiles
├── Protos/               # Protocol buffer definitions
└── Services/             # Business logic services

API Documentation

The API supports both gRPC and REST endpoints through HTTP/JSON transcoding. Available services:

Auth Service

• POST /v1/auth/authenticate - User authentication
• POST /v1/auth/refresh - Refresh access token

Order Service

• POST /v1/orders - Create order
• GET /v1/orders/{id} - Get order by ID

Order Import Service

• POST /v1/orders/import - Import orders from CSV
• POST /v1/orders/import-streaming - Stream import orders from CSV
• GET /v1/orders/export - Export orders to CSV
• GET /v1/orders/export-streaming - Stream export orders to CSV

Configuration

Key configuration files:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning",
      "Grpc": "Information"
    }
  },
  "Jwt": {
    "Key": "6166123c8fc4be6e600db6fd0f81788fb50c4aacbde28124f7afaee2144e00b9f0d66818f3af9a967d1ec508e53e3104729ef07101685c1507a4bb9a5bb4fee55a2e9aed4f60d4b23b347636b2bb8ac5abd11dd6a8e57233cba01dd264687b26d6aa1427efcd711350c516edc1fe9e001cdfb19f4704e26cfbefd9ddc5ca662e53b3625d36b3a321bc80e860587d03d2e563e8d80f184a6bc42a1fa6316a9ca234fb0724a7cef751b2d2887b53655b0525b7e47da22fb9caf9f02f7bdf011a2f0b6cde302db547598e43bc1f5c64382bdcc4ed60ff37057ca6733fd7281dfa96eb0c6134a9613f083bd9446cab0aeeedfdc504fd4f689bc0f0316ea1889620b7",
    "Issuer": "GrpcCrudBoilerplate",
    "Audience": "YourAudience"
  }
}

Security

The project implements several security best practices:

1. Authentication: JWT tokens with refresh token support
2. Password Security: Argon2 password hashing
3. Authorization: Fine-grained permission-based access control
4. API Security:
   • HTTPS enforcement
   • Input validation
   • Exception handling
   • Rate limiting (configurable)

Logging

Structured logging is implemented using Serilog with multiple sinks:

Log.Logger = new LoggerConfiguration()
    .Enrich.FromLogContext()
    .Enrich.With<CorrelationIdEnricher>()
    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}")
    .WriteTo.File("logs/GrpcCrudBoilerplate-.txt", rollingInterval: RollingInterval.Day,
        outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {CorrelationId} {Message:lj}{NewLine}{Exception}")
    .CreateLogger();

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• gRPC
• ASP.NET Core
• Entity Framework Core
• Serilog
• Swagger