Skip to main content

Introduction

Alert.CA.CameraEnvironment.API

A .NET 8 Web API for managing and monitoring camera environments, designed for integration with Azure services.

Features​

  • Secure configuration with Azure App Configuration and Key Vault
  • Integration with Azure Cosmos DB (via options pattern)
  • OpenAPI/Swagger documentation
  • Azure AD authentication
  • .NET 8 and C# 12 support

Getting Started​

Prerequisites​

  • .NET 8 SDK
  • Azure CLI (for local development)
  • Access to Azure App Configuration and Key Vault (for secrets/config)

Installation​

  1. Clone the repository:
  2. Set up user secrets (for local development):
  3. Restore dependencies:

Configuration​

  • The API expects an Azure App Configuration endpoint in ConnectionStrings:AppConfig.
  • Cosmos DB options are configured via Azure App Configuration.

Running the API​

The API will be available at https://localhost:5001 (or as configured).

Build and Test​

  • To build the project:
  • To run tests (if available):

API Documentation​

  • Swagger UI is available at /swagger when running the API locally.
  • OpenAPI definitions are generated automatically.

Contribute​

Contributions are welcome! To contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Commit your changes
  4. Push to your fork and submit a pull request

Please ensure your code follows the existing style and includes appropriate tests.

Resources​

License​

This project is licensed under the MIT License.