MiiaJS

Quick Start

Build your first MiiaJS API in under a minute.
Want the fastest path? Run npx @miiajs/cli new my-app to scaffold a ready-to-run project with a controller, service, and module already wired up.

1. Create a controller

import type { RequestContext } from '@miiajs/core'
import { Controller, Get, Post } from '@miiajs/core'

@Controller('/hello')
class HelloController {
  @Get('/')
  greet() {
    return { message: 'Hello, Miia!' }
  }

  @Get('/:name')
  greetUser(ctx: RequestContext) {
    return { message: `Hello, ${ctx.params.name}!` }
  }

  @Post('/')
  async echo(ctx: RequestContext) {
    const body = await ctx.req.json()
    return { received: body }
  }
}

2. Create a module

import { Module } from '@miiajs/core'

@Module({
  controllers: [HelloController]
})
class AppModule {}

3. Create the app and start the server

app.listen() initializes the DI container, compiles routes, and starts the server. Bun and Deno are auto-detected; for Node.js pass a server adapter:

import { Miia } from '@miiajs/core'

const app = new Miia().register(AppModule)

await app.listen(3000)

4. Test it

curl http://localhost:3000/hello
# {"message":"Hello, Miia!"}

curl http://localhost:3000/hello/world
# {"message":"Hello, world!"}

curl -X POST http://localhost:3000/hello \
  -d '{"foo":"bar"}' \
  -H "Content-Type: application/json"
# {"received":{"foo":"bar"}}

Next steps

  • Add services with @Injectable() and @Inject() or inject()
  • Add validation with @ValidateBody() and any ZodLike schema
  • Add authentication with @miiajs/auth
  • Generate API docs with @miiajs/swagger

Installation

Install MiiaJS and a server adapter for your runtime.

Core Concepts

Learn the fundamental building blocks of a MiiaJS application.