Weik.io

Data APIs

Generate REST APIs automatically from databases

Data APIs generate REST APIs directly from your databases, so you do not need to write backend code to expose a table.

Overview

You point the platform at an existing database, and it generates an API. Supported databases include:

  • PostgreSQL
  • MySQL
  • SQL Server
  • ODBC
  • Oracle

Features

  • Auto-generated endpoints
  • Built-in OpenAPI documentation
  • Standard query support (filtering, sorting, and pagination)
  • Direct integration with API subscriptions for access control

Creating Data APIs

You can create a Data API through the UI. Select the database type, provide connection details, set the route, and choose how to authenticate.

Configuration example

apiVersion: weikio/v1
kind: OpenApiEndpoint
metadata:
  name: sql-customers
spec:
  apiName: Weikio.ApiFramework.Plugins.SqlServer
  apiVersion: 1.0.0
  route: /api/v1/customers
  configuration:
    connectionString: "Server=localhost;Database=Customers;Trusted_Connection=True;"

Note: The kind is currently OpenApiEndpoint. The kind is planned to be renamed to DataApi in a future release.

Authentication

To restrict access to a Data API, use an ApiSubscription:

apiVersion: weik.io/v1alpha1
kind: ApiSubscription
metadata:
  name: data-api-access
spec:
  apis:
    - sql-customers
  isActive: true
  parameters:
    key: "your-api-key"

Practical uses

Common scenarios include:

  • Exposing a legacy database as a REST API without writing a middleware layer
  • Providing a data backend for a mobile app
  • Building an internal dashboard quickly

Next steps