Skip to content
Weik.ioDocs
2026.1
Try Weik.io

You're reading a page of the Weik.io 2026.1 docs. The current release is 2026.2. Read the 2026.2 page

Api Configuration

Weik.io 2026.1

Configure APIs with URL prefixes and routing.

On this page

Defines the basic configuration for an API, including its URL prefix for routing.

Schema properties#

Property Type Required Default Description
prefix string Yes - URL prefix for the API endpoints (e.g., “northwind”, “api/products”)

YAML example#

apiVersion: weik.io/v1alpha1
kind: Api
metadata:
  name: northwind-api
spec:
  prefix: northwind

Multiple APIs example#

apiVersion: weik.io/v1alpha1
kind: Api
metadata:
  name: products-api
spec:
  prefix: api/products
---
apiVersion: weik.io/v1alpha1
kind: Api
metadata:
  name: orders-api
spec:
  prefix: api/orders
---
apiVersion: weik.io/v1alpha1
kind: Api
metadata:
  name: customers-api
spec:
  prefix: api/customers

Usage notes#

Use Api configuration to define the base path for your API. The prefix determines the URL structure where the API endpoints are accessible.

The prefix should:

  • Have no leading slash
  • Be unique across all APIs in your instance
  • Follow URL path conventions (lowercase, hyphen-separated)

Example URL structure:

  • API with prefix northwind → Endpoints accessible at https://your-host/northwind/v1/...
  • API with prefix api/products → Endpoints accessible at https://your-host/api/products/v1/...

Combine this configuration with ApiVersion to define specific versions and their settings.

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo