How to structure large apis using hono?

[OultimoCoder]

Traditionally using express I would have this file structure:

── routes
    ├── index.js
    ├── users.route.js
── index.js  

And then in users.route.js I would define all my routes relating to users e.g.

const router = express.Router();

router
  .route('/')
  .post(auth('manageUsers'), validate(userValidation.createUser), userController.createUser)
  .get(auth('getUsers'), validate(userValidation.getUsers), userController.getUsers);

router
  .route('/:userId')
  .get(auth('getUsers'), validate(userValidation.getUser), userController.getUser)
  .patch(auth('manageUsers'), validate(userValidation.updateUser), userController.updateUser)
  .delete(auth('manageUsers'), validate(userValidation.deleteUser), userController.deleteUser);

module.exports = router;

In routes/index.js I would apply the base urls to all my defined routes and then in the top level index.js I would import and enable them:

// v1 api routes
app.use('/v1', routes);

What is the recommended way of doing this in Hono?

[yusukebe]

Hi @OultimoCoder

Currently, we can write routing using route like this:

export const app = new Hono()

const root = app.route('/v1')
root.get('/', (c) => c.text('getUsers'))
root.post('/', (c) => c.text('createUser'))

And, This syntax may be available in the next release.

root.post('/', basicAuth(), cors(), (c) => c.text('getUsers')) // <--- this syntax is coming soon!

I think this is not such a smart design for large APIs, so I want to add another way for routing, such as below:

import { Hono, Route } from 'hono'

const app = new Hono()
const route = new Route()

route.get('/entry', handler, handler).post(handler, handler)

app.use('/v1', route)
app.fire()

This is still just the idea.

Conclusion, please use app.route method. Thank you.

[OultimoCoder]

What is the eta for the next release? Thanks!

[yusukebe]

@OultimoCoder

This feature is already implemented #203 .
We are planning to emit this feature in the next release v1.2.0. Maybe its' soon!

[yusukebe]

@OultimoCoder

We released v1.2.0. See: https://github.com/honojs/hono/releases/tag/v1.2.0.

[yusukebe]

Hi @OultimoCoder

Route is deprecated. Please use the Hono instance!

https://github.com/honojs/hono#grouping