Getting started
Base URLs
| Environment | Base URL | Notes |
|---|---|---|
| Local | http://localhost:7137 | Portal VITE_APP_API_URL default in development |
| PTL DEV | https://gals-api-dev2-c98f.italynorth.azurecontainer.io | Caddy TLS sidecar on ACI |
| MITA DEV | Public HTTPS API URL (Cloudflare when configured) | Private VNet ACI; see CI/CD guide |
All controller routes are rooted at the service origin with no /api prefix. Examples:
<pre><code class="language-bash">GET /hc GET /Employee/Me GET /Contract/GetList?baseYear=2026 POST /CycleInvoicing/Retrieve
Health check
GET /hc is anonymous and used by deploy smoke tests.
<pre><code class="language-bash">curl -fsS https://gals-api-dev2-c98f.italynorth.azurecontainer.io/hc
A successful response returns HTTP 200.
Interactive Swagger (Local / Development only)
When ASPNETCORE_ENVIRONMENT is Development or Local, the service serves Swagger UI at / and the OpenAPI document at /swagger/v1/swagger.json. Production and ACI environments do not expose Swagger.
Local docs preview
1. Restore the Swashbuckle CLI and regenerate the committed OpenAPI file from the built service:
<pre><code class="language-bash">dotnet tool restore dotnet build gals.service.backend.slnx -c Release -p:Platform=x64 ASPNETCORE_ENVIRONMENT=Development \ dotnet swagger tofile \ --output docs/api-reference/openapi.json \ Service/bin/x64/Release/net10.0/Service.dll \ v1
On Windows PowerShell, set the environment variable for the process:
<pre><code class="language-powershell">$env:ASPNETCORE_ENVIRONMENT = "Development" dotnet swagger tofile --output docs/api-reference/openapi.json Service/bin/x64/Release/net10.0/Service.dll ` v1
2. Install the Mintlify CLI and start the preview from docs/:
<pre><code class="language-bash">npm i -g mint cd docs mint dev
Printing pages
Guide pages include a Print this page control implemented as a Vue 3 component (components/PrintButton.vue, mounted by print.js). It opens the browser print dialog against the content currently deployed on this site, so prints always reflect the latest released docs bundle.
API reference pages are generated from OpenAPI and do not include the button. Use the browser Ctrl+P / Cmd+P shortcut instead ? the site-wide print stylesheet still hides navigation chrome for clean output.