server#

Declares transport-level settings: listener interface and port binding, connection timeouts, maximum request body size, RFC 9457 problem type resolution, and global OpenAPI metadata.

#Declaration

server {
  host          = "0.0.0.0"
  port          = 8080
  read_timeout  = "15s"
  write_timeout = "30s"
  idle_timeout  = "60s"
  max_body_size = "25MB"

  problem {
    type_prefix = "https://docs.mycompany.com/errors/"
  }

  openapi {
    title   = "Acme Storefront API"
    version = "1.0.0"
  }
}

#Transport attributes

All attributes are optional and inherit production-ready defaults.

#Child blocks

#problem

Configures RFC 9457 Problem Details error type resolution for the application.

server {
  problem {
    type_prefix = "https://docs.mycompany.com/errors/"
  }
}

#Problem type URI resolution

• Without problem.type_prefix (default): Emits standard URNs (urn:hclapi:error:bad-request).
• With a documentation URL: type_prefix = "https://docs.example.com/errors/" resolves to https://docs.example.com/errors/bad-request.
• With a custom URN prefix: type_prefix = "urn:acme:error:" resolves to urn:acme:error:bad-request.

#openapi

Declares top-level metadata for the automatically compiled OpenAPI 3.1 specification (title, description, deployment servers, category tags, contact, and license).

server {
  openapi {
    title       = "Acme Storefront API"
    version     = "1.2.0"
    description = "Customer accounts and order processing API."
  }
}

#Example

server {
  host          = "0.0.0.0"
  port          = 8080
  read_timeout  = "30s"
  write_timeout = "60s"
  idle_timeout  = "120s"
  max_body_size = "50MB"

  problem {
    type_prefix = "https://developer.example.com/api/errors/"
  }

  openapi {
    title   = "Production API Gateway"
    version = "2.0.0"
  }
}