Skip to main content

API Gateway

Once you have defined your resources, you can group them into a single Hono application using defineApi.

Registering Resources​

defineApi takes an object where the keys are the base paths for each resource.

import { defineApi } from "../honocube";
import { usersResource } from "./users";
import { postsResource } from "./posts";

export const api = defineApi({
  users: usersResource,
  posts: postsResource,
});

This will create a Hono instance with the following routing structure:

  • /users/* (mounted with usersResource apps)
  • /posts/* (mounted with postsResource apps)

Versioning​

You can optionally provide a version string to prefix all routes.

export const v1Api = defineApi({
  users: usersResource,
}, "v1");

Resulting path: /v1/users

Mounting to a Main App​

The result of defineApi is a standard Hono instance, so you can mount it to your main server application easily.

import { Hono } from "hono";
import { api } from "./resources";

const app = new Hono();

// Mount the Honocube API
app.route("/api", api);

export default app;

Custom Global Middleware​

Since the gateway is just a Hono app, you can apply global middleware (like CORS or Auth) before mounting the resources.

import { cors } from "hono/cors";

const api = defineApi({ ... });
api.use("*", cors());

Congratulations! You've learned the core concepts of Honocube. For more specific patterns, check out the Guides.