Hono
Framework web ultrarrápido para o edge, com suporte a Cloudflare Workers, Deno, Bun, Vercel, AWS Lambda e Node.js sem nenhuma dependência.
Instalação
Seção intitulada “Instalação”Criar Novo Projeto
Seção intitulada “Criar Novo Projeto”| Comando | Descrição |
|---|---|
npm create hono@latest my-app | Criar novo projeto Hono com npm |
yarn create hono my-app | Criar com Yarn |
pnpm create hono my-app | Criar com pnpm |
bun create hono my-app | Criar com Bun |
deno init --lib hono | Criar com Deno |
Adicionar a Projeto Existente
Seção intitulada “Adicionar a Projeto Existente”| Comando | Descrição |
|---|---|
npm install hono | Instalar Hono em projeto existente |
yarn add hono | Instalar com Yarn |
pnpm add hono | Instalar com pnpm |
bun add hono | Instalar com Bun |
Templates Iniciais
Seção intitulada “Templates Iniciais”# Create project with specific runtime template
npm create hono@latest my-app -- --template cloudflare-workers
npm create hono@latest my-app -- --template bun
npm create hono@latest my-app -- --template deno
npm create hono@latest my-app -- --template nodejs
npm create hono@latest my-app -- --template vercel
npm create hono@latest my-app -- --template aws-lambda
npm create hono@latest my-app -- --template cloudflare-pages
npm create hono@latest my-app -- --template fastly
Roteamento Básico
Seção intitulada “Roteamento Básico”Métodos HTTP
Seção intitulada “Métodos HTTP”| Comando | Descrição |
|---|---|
app.get('/path', handler) | Lidar com requisições GET |
app.post('/path', handler) | Lidar com requisições POST |
app.put('/path', handler) | Lidar com requisições PUT |
app.delete('/path', handler) | Lidar com requisições DELETE |
app.patch('/path', handler) | Lidar com requisições PATCH |
app.options('/path', handler) | Lidar com requisições OPTIONS |
app.all('/path', handler) | Lidar com todos os métodos HTTP |
app.on('PURGE', '/path', handler) | Lidar com métodos personalizados |
Hello World
Seção intitulada “Hello World”import { Hono } from 'hono'
const app = new Hono()
app.get('/', (c) => {
return c.text('Hello Hono!')
})
app.get('/json', (c) => {
return c.json({ message: 'Hello', status: 'ok' })
})
app.get('/html', (c) => {
return c.html('<h1>Hello Hono!</h1>')
})
export default app
Parâmetros de Rota
Seção intitulada “Parâmetros de Rota”// Path parameters
app.get('/users/:id', (c) => {
const id = c.req.param('id')
return c.json({ id })
})
// Multiple parameters
app.get('/posts/:postId/comments/:commentId', (c) => {
const { postId, commentId } = c.req.param()
return c.json({ postId, commentId })
})
// Optional parameter
app.get('/api/:version?/users', (c) => {
const version = c.req.param('version') || 'v1'
return c.json({ version })
})
// Wildcard
app.get('/files/*', (c) => {
const path = c.req.path
return c.text(`File path: ${path}`)
})
// Regex-like patterns
app.get('/user/:id{[0-9]+}', (c) => {
const id = c.req.param('id')
return c.json({ id: Number(id) })
})
Tratamento de Requisições
Seção intitulada “Tratamento de Requisições”Parâmetros de Query
Seção intitulada “Parâmetros de Query”| Comando | Descrição |
|---|---|
c.req.query('key') | Obter parâmetro de query único |
c.req.query() | Obter todos os parâmetros de query |
c.req.queries('tags') | Obter array de valores para uma chave |
Corpo da Requisição
Seção intitulada “Corpo da Requisição”| Comando | Descrição |
|---|---|
c.req.json() | Fazer parse do corpo como JSON |
c.req.text() | Obter corpo como texto |
c.req.formData() | Fazer parse de dados de formulário |
c.req.blob() | Obter corpo como Blob |
c.req.arrayBuffer() | Obter corpo como ArrayBuffer |
c.req.parseBody() | Fazer parse automático do corpo por tipo de conteúdo |
Cabeçalhos e Metadados
Seção intitulada “Cabeçalhos e Metadados”| Comando | Descrição |
|---|---|
c.req.header('Content-Type') | Obter cabeçalho da requisição |
c.req.header() | Obter todos os cabeçalhos |
c.req.method | Obter método HTTP |
c.req.url | Obter URL completa da requisição |
c.req.path | Obter caminho da requisição |
c.req.raw | Obter objeto Request bruto |
c.req.valid('json') | Obter dados validados |
Exemplo de Requisição
Seção intitulada “Exemplo de Requisição”app.post('/users', async (c) => {
const body = await c.req.json()
const page = c.req.query('page') || '1'
const auth = c.req.header('Authorization')
return c.json({
user: body,
page: Number(page),
authenticated: !!auth
}, 201)
})
Auxiliares de Resposta
Seção intitulada “Auxiliares de Resposta”Tipos de Resposta
Seção intitulada “Tipos de Resposta”| Comando | Descrição |
|---|---|
c.text('Hello') | Resposta em texto simples |
c.json({ key: 'value' }) | Resposta em JSON |
c.html('<h1>Hi</h1>') | Resposta em HTML |
c.redirect('/new-url') | Redirecionamento 302 |
c.redirect('/new-url', 301) | Redirecionamento 301 permanente |
c.notFound() | Resposta 404 |
c.body(data) | Resposta com corpo bruto |
c.newResponse(body, status, headers) | Resposta personalizada completa |
Cabeçalhos de Resposta e Streaming
Seção intitulada “Cabeçalhos de Resposta e Streaming”// Set headers
app.get('/api/data', (c) => {
c.header('X-Custom-Header', 'value')
c.header('Cache-Control', 'max-age=3600')
return c.json({ data: 'example' })
})
// Set status code
app.post('/items', async (c) => {
const item = await c.req.json()
return c.json(item, 201)
})
// Stream response
app.get('/stream', (c) => {
return c.streamText(async (stream) => {
await stream.write('Hello ')
await stream.sleep(1000)
await stream.write('World!')
})
})
Middleware
Seção intitulada “Middleware”Middleware Integrado
Seção intitulada “Middleware Integrado”| Comando | Descrição |
|---|---|
import { cors } from 'hono/cors' | Middleware CORS |
import { logger } from 'hono/logger' | Registro de requisições |
import { prettyJSON } from 'hono/pretty-json' | Formatação bonita de respostas JSON |
import { basicAuth } from 'hono/basic-auth' | Autenticação básica |
import { bearerAuth } from 'hono/bearer-auth' | Autenticação por token Bearer |
import { jwt } from 'hono/jwt' | Autenticação JWT |
import { compress } from 'hono/compress' | Compressão Gzip/Brotli |
import { etag } from 'hono/etag' | Cache com ETag |
import { secureHeaders } from 'hono/secure-headers' | Cabeçalhos de segurança |
import { csrf } from 'hono/csrf' | Proteção contra CSRF |
import { timing } from 'hono/timing' | Cabeçalho Server-Timing |
import { cache } from 'hono/cache' | Controle de cache |
import { bodyLimit } from 'hono/body-limit' | Limite de tamanho do corpo da requisição |
Uso de Middleware
Seção intitulada “Uso de Middleware”import { Hono } from 'hono'
import { cors } from 'hono/cors'
import { logger } from 'hono/logger'
import { secureHeaders } from 'hono/secure-headers'
import { bearerAuth } from 'hono/bearer-auth'
const app = new Hono()
// Global middleware
app.use('*', logger())
app.use('*', secureHeaders())
app.use('*', cors({
origin: ['https://example.com'],
allowMethods: ['GET', 'POST', 'PUT', 'DELETE'],
allowHeaders: ['Content-Type', 'Authorization'],
maxAge: 86400,
}))
// Route-specific middleware
app.use('/api/*', bearerAuth({ token: 'my-secret-token' }))
// Custom middleware
app.use('*', async (c, next) => {
const start = Date.now()
await next()
const duration = Date.now() - start
c.header('X-Response-Time', `${duration}ms`)
})
Autenticação JWT
Seção intitulada “Autenticação JWT”import { jwt, sign } from 'hono/jwt'
const app = new Hono()
const SECRET = 'my-secret-key'
app.use('/api/*', jwt({ secret: SECRET }))
app.post('/login', async (c) => {
const { email, password } = await c.req.json()
const token = await sign(
{ email, exp: Math.floor(Date.now() / 1000) + 3600 },
SECRET
)
return c.json({ token })
})
app.get('/api/profile', (c) => {
const payload = c.get('jwtPayload')
return c.json({ email: payload.email })
})
Validação
Seção intitulada “Validação”Validador Zod
Seção intitulada “Validador Zod”import { zValidator } from '@hono/zod-validator'
import { z } from 'zod'
const userSchema = z.object({
name: z.string().min(1),
email: z.string().email(),
age: z.number().int().positive().optional(),
})
app.post(
'/users',
zValidator('json', userSchema),
(c) => {
const user = c.req.valid('json')
return c.json(user, 201)
}
)
// Validate query parameters
const querySchema = z.object({
page: z.string().optional().default('1'),
limit: z.string().optional().default('10'),
})
app.get(
'/users',
zValidator('query', querySchema),
(c) => {
const { page, limit } = c.req.valid('query')
return c.json({ page, limit })
}
)
Grupos de Rotas
Seção intitulada “Grupos de Rotas”const app = new Hono()
// Group routes with basePath
const api = new Hono().basePath('/api')
api.get('/users', (c) => c.json({ users: [] }))
api.post('/users', (c) => c.json({ created: true }))
app.route('/', api)
// Versioned APIs
const v1 = new Hono()
v1.get('/health', (c) => c.json({ status: 'ok' }))
const v2 = new Hono()
v2.get('/health', (c) => c.json({ status: 'ok', version: 2 }))
app.route('/api/v1', v1)
app.route('/api/v2', v2)
Tratamento de Erros
Seção intitulada “Tratamento de Erros”import { HTTPException } from 'hono/http-exception'
// Custom 404
app.notFound((c) => {
return c.json({ error: 'Not Found' }, 404)
})
// Global error handler
app.onError((err, c) => {
if (err instanceof HTTPException) {
return err.getResponse()
}
console.error(err)
return c.json({ error: 'Internal Server Error' }, 500)
})
// Throw HTTP exceptions
app.get('/admin', (c) => {
if (!c.req.header('Authorization')) {
throw new HTTPException(401, { message: 'Unauthorized' })
}
return c.json({ admin: true })
})
Configuração por Runtime
Seção intitulada “Configuração por Runtime”Cloudflare Workers
Seção intitulada “Cloudflare Workers”import { Hono } from 'hono'
type Bindings = {
MY_KV: KVNamespace
MY_DB: D1Database
}
const app = new Hono<{ Bindings: Bindings }>()
app.get('/kv/:key', async (c) => {
const value = await c.env.MY_KV.get(c.req.param('key'))
return c.json({ value })
})
export default app
Node.js
Seção intitulada “Node.js”import { Hono } from 'hono'
import { serve } from '@hono/node-server'
const app = new Hono()
app.get('/', (c) => c.text('Hello Node.js!'))
serve({ fetch: app.fetch, port: 3000 })
import { Hono } from 'hono'
const app = new Hono()
app.get('/', (c) => c.text('Hello Bun!'))
export default { port: 3000, fetch: app.fetch }
import { Hono } from 'npm:hono'
const app = new Hono()
app.get('/', (c) => c.text('Hello Deno!'))
Deno.serve(app.fetch)
RPC e Cliente
Seção intitulada “RPC e Cliente”Cliente RPC com Tipagem Segura
Seção intitulada “Cliente RPC com Tipagem Segura”// server.ts
import { Hono } from 'hono'
import { zValidator } from '@hono/zod-validator'
import { z } from 'zod'
const app = new Hono()
.get('/api/users', (c) => {
return c.json({ users: [{ id: 1, name: 'Alice' }] })
})
.post(
'/api/users',
zValidator('json', z.object({ name: z.string() })),
(c) => {
const { name } = c.req.valid('json')
return c.json({ id: 2, name }, 201)
}
)
export type AppType = typeof app
export default app
// client.ts — fully typed
import { hc } from 'hono/client'
import type { AppType } from './server'
const client = hc<AppType>('http://localhost:3000')
// Fully typed — autocomplete for routes + responses
const res = await client.api.users.$get()
const data = await res.json()
// data: { users: { id: number, name: string }[] }
import { testClient } from 'hono/testing'
const app = new Hono()
.get('/hello', (c) => c.json({ message: 'Hello!' }))
// Using testClient (type-safe)
const client = testClient(app)
const res = await client.hello.$get()
const body = await res.json()
// body.message === 'Hello!'
// Using app.request() directly
const res2 = await app.request('/hello')
// res2.status === 200
Boas Práticas
Seção intitulada “Boas Práticas”-
Use generics TypeScript para bindings de ambiente — Defina
Hono<{ Bindings: MyBindings }>para obter tipagem segura para variáveis de ambiente, namespaces KV e bancos de dados D1. -
Valide todas as entradas com Zod — Use
@hono/zod-validatorpara validação de corpo da requisição, query e parâmetros. Isso proporciona segurança em tempo de execução e tipos TypeScript em um único passo. -
Use o cliente RPC para frontend-backend — Exporte
AppTypedo seu servidor e usehc<AppType>()no cliente para tipagem segura de ponta a ponta sem geração de código. -
Aplique middleware com padrões de caminho — Use
app.use('/api/*', middleware)para limitar o escopo do middleware a rotas específicas em vez de aplicar tudo globalmente. -
Agrupe rotas com
new Hono().basePath()— Organize endpoints relacionados em instâncias Hono separadas e monte-as comapp.route()para separação limpa. -
Trate erros globalmente — Use
app.onError()eapp.notFound()para garantir que todo erro retorne uma resposta JSON estruturada em vez de stack traces. -
Use
c.executionCtx.waitUntil()— Para trabalho em segundo plano no Cloudflare Workers (analytics, logging), usewaitUntil()para evitar bloquear a resposta. -
Mantenha os handlers enxutos — Extraia a lógica de negócio para funções/módulos separados. Os handlers de rota devem fazer parse da entrada, chamar a lógica e retornar respostas.
-
Teste com
testClient— O cliente de teste integrado do Hono tem tipagem segura e não precisa de um servidor em execução, tornando os testes unitários rápidos e confiáveis. -
Implante onde seus usuários estão — O Hono executa em todos os principais runtimes de edge. Escolha Cloudflare Workers para edge global, Bun para velocidade pura ou Node.js para compatibilidade com o ecossistema.