Adding new endpoint

Create new module

To create a new module you can create a new folder in the modules folder. For example modules/posts.

Then you would need to create a router declaration for this module. We're following a convention with the filename suffixes, so you would need to create a file named posts.router.ts in the modules/posts folder.

import { zValidator } from "@hono/zod-validator";
import { Hono } from "hono";
 
export const postsRouter = new Hono().get(
  "/",
  zValidator("query", filtersSchema),
  (c) => getAllPosts(c.req.valid("query")),
);

As you can see we're implementing a .get method without any additional middlewares for the router. This is a simple way to define a new GET endpoint.

Also, we're using a zod validator to ensure that input passed to the endpoint is correct.

Maybe mutation?

The same way you can define a mutation for the new entity, just by changing the get to post:

export const postsRouter = new Hono().post(
  "/",
  enforceAuth,
  zValidator("json", postSchema),
  (c) => createPost(c.req.valid("json")),
);

Hono supports all HTTP methods, so you can define a new endpoint for any method you need (e.g. put, delete, etc.).

The enforceAuth middleware ensures that only authenticated users can access the endpoint, while the zod validator checks if the input data matches the expected schema. This combination provides both authentication and data validation in a single, clean setup.

Read more about protected routes.

Implement logic

Then you would need to create a controller for this module. There is a place, where the logic happens, e.g. for the GET / endpoint we would need to create a getAllPosts function which will fetch posts from the database.

import { db } from "@turbostarter/db/server";
import { posts } from "@turbostarter/db/schema";
 
export const getAllPosts = (filters: Filters) => {
  return db.select().from(posts).all().where(/* your filter logic here */);
};

Register router

To make the module and its endpoints available in the API you need to register a router for this module in the index.ts file:

import { postsRouter } from "./modules/posts/posts.router";
 
const appRouter = new Hono()
  .basePath("/api")
  .route("/posts", postsRouter)
  /* other routers from your app logic */
  .onError(onApiError);
 
type AppRouter = typeof appRouter;
 
export type { AppRouter };
export { appRouter };

The basePath method sets a prefix for all routes in this router. While optional, using it helps organize API endpoints. This modular approach makes the API structure clearer and easier to maintain.