createApiServer

createApiServer is the primary factory function for building a LakeQL API instance. It wires together Hono, GraphQL Yoga, and all middleware into a ready-to-use server object.

Signature #

1
2
function createApiServer(options?: ApiRuntimeConfig): Promise<ApiServer>

Return type #

What it sets up #

1. Creates a structured logger via @lakeql/logger
2. Initializes GraphQL Yoga with the loaded schema and context
3. Mounts Hono logger middleware on all routes
4. Configures CORS on the GraphQL path (POST, GET, OPTIONS)
5. Connects the Yoga request handler to Hono

Usage #

1
2
3
4
5
6
7
8
9
10
11
12
import { createApiServer } from "@lakeql/api/server"

const { app, logger, yoga } = await createApiServer({
  baseDir: import.meta.dirname,
  schemaPath: "./schemas",
  graphqlPath: "/graphql",
  port: 4000,
})

// Add custom middleware or routes to the Hono app
app.get("/health", (c) => c.json({ status: "ok" }))

Starting the server #

For most projects, use defineConfig with startServer() instead of calling createApiServer directly:

1
2
3
4
import { config } from "./config"

await config.startServer()

If you don't need defineConfig, startApiServer calls createApiServer internally and binds to a port:

1
2
3
4
5
6
7
8
import { startApiServer } from "@lakeql/api/server"

await startApiServer({
  baseDir: import.meta.dirname,
  schemaPath: "./schemas",
  port: 4000,
})

startApiServer uses @hono/node-server to serve the application via Node.js http module.