Configuration Reference

Complete reference documentation for all NpgsqlRest configuration options.

For an introduction to how configuration works (sources, precedence, environment variables, command-line arguments), see the Configuration Guide.

Reference Sections

Core Settings

• Top-Level Settings - Application identity, URLs, and config behavior
• NpgsqlRest Options - Core API generation settings (URL prefixes, naming conventions, request handling)
• Routine Options - PostgreSQL routine handling (language filtering, custom types)
• Connection - Database connection strings and settings
• Server - Kestrel web server and SSL/TLS configuration

Security

• Authentication - Authentication providers (JWT, Cookie, Basic, etc.)
• Authentication Options - Per-endpoint authentication configuration
• Antiforgery - CSRF protection settings
• Data Protection - Key storage and encryption settings
• CORS - Cross-Origin Resource Sharing configuration

Features

• CRUD - Automatic CRUD endpoint generation for tables
• OpenAPI - OpenAPI/Swagger documentation generation
• HTTP Files - HTTP test file generation
• Code Generation - Client code generation (TypeScript, etc.)
• Uploads - File upload handling

Performance

• Response Compression - Gzip/Brotli compression settings
• Cache Options - Response caching configuration
• Rate Limiter - Rate limiting settings
• Command Retry - Database command retry policies
• Thread Pool - Thread pool configuration

Infrastructure

• Logging - Log levels and output configuration
• Static Files - Static file serving configuration
• Error Handling - Error response configuration