Smart Accountant API

Before run

• Fill in the blank secrets in appsettings.json.

Development guidelines

• All ValidationExceptions are handled by an exception filter. No need to handle them in controllers.

• In XML documentation of methods, sort exceptions by complexity of the error case. E.g.:

/// <exception cref="ImportException"/>
/// <exception cref="ValidationException"/>
/// <exception cref="OperationCanceledException" />
/// <exception cref="ArgumentNullException"/>

• Add the following to the beginning of EF migration classes to prevent code style and quality checks:

// <auto-generated />

Also make those classes internal, please.

Test projects

• Add the following build property to all test projects:

<TestProject>true</TestProject>

• SDK version of test projects (MSTest.Sdk) needs to be manually updated rather than through individual NuGet package updates. See https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-mstest-sdk#known-limitations.

• Name test methods as that have 'should'/'must' in the beginning of the name. E.g., ThrowValidationExceptionForInvalidRequest().

NuGet packages

Use command below to add NuGet packages to a local store during development.

nuget add -Source "path\to\your\local\nuget\store" .\SmartAccountant.Models\bin\Debug\SmartAccountant.Models.1.0.0.nupkg

Build status