Skip to main content

createFdmApi

@nmi-agro/fdm-source

@nmi-agro/fdm-source / fdm-api/src / createFdmApi

Function: createFdmApi()

createFdmApi(fdm, auth, config, services?): OpenAPIHono<ApiEnv>

Defined in: fdm-api/src/index.ts:290

Creates a fully configured Hono application for the FDM REST API.

Parameters​

fdm​

FdmType

Database and service context from @nmi-agro/fdm-core.

auth​

FdmAuth

Authentication service used to verify incoming API keys.

config​

FdmApiConfig

Public API configuration such as names, URLs, and base path.

services?​

Partial<FdmApiServices> = {}

Optional service overrides for testing or custom data access behaviour.

Returns​

OpenAPIHono<ApiEnv>

An OpenAPIHono application with middleware, routes, OpenAPI output, and docs UI registered.

Example​

const app = createFdmApi(fdm, auth, {
  appName: "My App",
  appUrl: "https://example.com",
  basePath: "/api",
})