RedShirt.Example.Api

Example of an ASP.NET Core API.

Repo features:

• Initialisation script for quick namespace adjustment.
• Use of NSwag to automatically document endpoints and to generate client code for an interop package.
  • Recommended next step: Exporting the interop package as a NuGet for use in other projects.
• Configurable rate limiting using a sliding window system:
  • Uses either Redis or in-memory for storing limits.
• Configuration is based on environment variables.

Initialisation

To change the namespace of the API en-masse for your purposes, use the init-repo.sh script:

bash init-repo.sh New.Namespace.Here

Configuration

This API is expected to be run out of a docker container, so it relies on environment variables for most of its configuration.

For configuration examples, see the api section of the test/local/docker-compose.yaml file.

Rate Limiting Configuration

This API is built with the option for rate limiting, using a sliding window system backed either by Redis or an in-memory system.

To make use of rate limiting, you must either:

• Use the [EnableRateLimiting("example")] attribute to name a policy (unlike the example on this list item, using constants for this is strongly encouraged).
• Set and configure a default policy to require rate limiting across all endpoints (unless ruled out by the use of the [DisableRateLimiting] attribute applied to an endpoint or controller).

Resources:

• For configuration examples, see the api section of the test/local/docker-compose.yaml file. Rate limiting is defined in environment variables beginning in RATE_LIMITING.
• To better understand the configuration definitions, refer to the classes in the Configuration/ folder of the Common.RateLimiting project

Testing

For local testing, see the test/local folder.

Citations

Rough citation of some sources beyond memory.

API

• RicoSuter/NSwag#2409 - on models not showing up
• https://github.com/RicoSuter/NSwag/wiki/NSwag.MSBuild
• https://stackoverflow.com/questions/33283071/swagger-webapi-create-json-on-build
• https://github.com/RicoSuter/NSwag/wiki/CommandLine/ce950c5aea7bf52a85ec6e517ad8ea96762181ed
• RicoSuter/NSwag#1573
  • Should use aspnetcore2swagger
• RicoSuter/NSwag#3119
  • Use nobuild to avoid infinite build loop
• https://github.com/RicoSuter/NSwag/wiki/NSwag-Configuration-Document
  • Doesn't include sourcing from an existing swagger.json though...
  • Derived 'Net80' runtime from phrasing in EXE variable
• https://stackoverflow.com/questions/63791017/generate-with-nswag-an-openapi-document-including-swashbuckle-custom-operation-f
  • Describes fromDocument section
  • Derive from Url, but we want path
• https://stackoverflow.com/questions/73016248/generating-c-sharp-api-client-with-nswag-msbuild\
  • Derive from Json
• https://stackoverflow.com/questions/59393267/generate-nswag-client-as-part-of-the-build
• Mentions rigging up before build
• https://github.com/RicoSuter/NSwag/wiki/AspNetCoreOpenApiDocumentGenerator
• https://github.com/RicoSuter/NSwag/blob/master/src/NSwag.Commands/Commands/Generation/AspNetCore/AspNetCoreToOpenApiCommand.cs
• https://github.com/RicoSuter/NSwag/blob/master/src/NSwag.Commands/Commands/OutputCommandBase.cs

Dynamo

• https://codewithmukesh.com/blog/pagination-in-amazon-dynamodb-with-dotnet/