DBConnectionAPI REST API documentation¶
DBConnectionAPI is an ASP.NET Core REST API that composes database connection strings (Oracle, SQL Server, PostgreSQL) for authorized callers from templates and secure credentials held in the SAIF Environment API. It validates Oracle and SQL Server strings with a throw-away connectivity probe and caches validated strings in process memory. It also exposes an administrative surface that returns the raw credential parts. Callers of this service are not determined from source**.
| Field | Value |
|---|---|
| Service | DBConnectionAPI (DBConnectionAPI/DBConnectionAPI/DBConnectionAPI.csproj) |
| Target framework | net10.0 (ASP.NET Core, SDK-style Microsoft.NET.Sdk.Web project) |
| Host model | Generic host — Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder => webBuilder.UseStartup<Startup>()); IIS in-process (<AspNetCoreHostingModel>InProcess) |
| Startup type | Startup : CoreAPIStartup (SAIF.NetCore.ServiceExtensions) |
| Routing mode | Attribute routes ([ApiController] + [Route]); no minimal APIs and no conventional routes |
| Versioning scheme | Literal route prefix (v1 followed by the controller route) — not API versioning; no versioning package |
| Base controller(s) | ControllerBase |
| Media types / serializer | Not declared in source (no [Produces], AddJsonOptions or AddNewtonsoftJson); the formatter in force is decided inside the opaque base** |
| OpenAPI | Swashbuckle Swashbuckle.AspNetCore 6.4.0 — UseSwagger + UseSwaggerUI (swagger/v1/swagger.json), active in every environment |
| Composition root | DBConnectionAPI/DBConnectionAPI/Startup.cs (ConfigureServices) |
| Health checks | None found; any ping endpoint contributed by the base class is not visible in source** |
Documentation sections¶
| Section | Description |
|---|---|
| Overview | Purpose, business context, and capability summary |
| Architecture | Layering, routing, the DI composition root, options binding, and error handling |
| Hosting pipeline | Host model, server, ordered middleware, versioning, OpenAPI, health checks, telemetry |
| Endpoints | Endpoint catalog with per-controller detail pages |
| Authentication and authorization | Authentication contributed by the base, authorization enforcement, and resource requirements |
| Dependencies | Libraries, packages, APIs, and database connections |
| Configuration | appsettings, Environment API settings, runtime-resolved connections |
| Operations and processes | End-to-end processing workflows behind the endpoints |
| Business rules | Rules enforced during request processing |
| Data model | Persistence model and connectivity-probe usage |
| Operational runbook | Deployment, health verification, logs, status codes, error recovery |
| Tech debt | CRITICAL and HIGH severity findings |
Controllers¶
| Controller | Route template | API version | Endpoints | Documentation |
|---|---|---|---|---|
AdminController |
v1/Admin plus the action name |
None (literal v1) |
3 | Docs |
ConnectionsController |
v1/Connections |
None (literal v1) |
3 | Docs |
Embedded libraries¶
No embedded libraries: the repository contains the API project and its test project only, and no project references.
Related documentation¶
- Overview
- Architecture
- Hosting pipeline
- Endpoints
- Authentication and authorization
- Dependencies
- Configuration
- Operations and processes
- Business rules
- Data model
- Operational runbook
- Tech debt
Note: Statements marked with
†are derived from dependency library documentation via the Legends CLI. Statements marked with*were inferred from code structure or contextual evidence. Statements marked with**could not be confirmed; treat as unknown until verified.
Sources¶
- DBConnectionAPI/DBConnectionAPI/DBConnectionAPI.csproj
- DBConnectionAPI/DBConnectionAPI/Program.cs
- DBConnectionAPI/DBConnectionAPI/Startup.cs
- DBConnectionAPI/DBConnectionAPI/Controllers/ConnectionsController.cs
- DBConnectionAPI/DBConnectionAPI/Controllers/AdminController.cs
- DBConnectionAPI/DBConnectionAPI/web.config