README
U
T
T
HttpBody
T
HttpEvent
T
HttpRequest
T
HttpResponse
T
LogLevel
- ::debugLogger::debug
- ::debug_strLogger::debug_str
- ::errorLogger::error
- ::infoLogger::info
- ::route_addedLogger::route_added
- ::route_createdLogger::route_created
- ::route_dynamicLogger::route_dynamic
- ::route_foundLogger::route_found
- ::route_lookupLogger::route_lookup
- ::route_merge_existingLogger::route_merge_existing
- ::route_merge_newLogger::route_merge_new
- ::route_not_foundLogger::route_not_found
- ::route_registerLogger::route_register
- ::route_staticLogger::route_static
- ::routes_availableLogger::routes_available
- ::warnLogger::warn
- ::allMocket::all
- ::connectMocket::connect
- ::deleteMocket::delete
- ::getMocket::get
- ::groupMocket::group
- ::headMocket::head
- ::onMocket::on
- ::optionsMocket::options
- ::patchMocket::patch
- ::postMocket::post
- ::putMocket::put
- ::serveMocket::serve
- ::traceMocket::trace
- ::use_middlewareMocket::use_middleware
V
new
V
new_debug_logger
V
new_logger
V
new_production_logger
V
run
V
serve_ffi
V
suspend

mocket

A web framework for MoonBit.

http

server

Download zip

Author

oboard

Version

0.5.0

License

Apache-2.0

Repository

github.com/oboard/mocket

Last updated

last year

Downloads

#oboard/mocket

A web framework for MoonBit.

#Quick Start

Mocket supports both js and native backends.

#JavaScript Backend

Set the backend of MoonBit to js in Visual Studio Code

Command: MoonBit: Select Backend -> js

moon run src/example --target js

#Native Backend

Set the backend of MoonBit to native in Visual Studio Code

Command: MoonBit: Select Backend -> native

moon run src/example --target native

Then visit http://localhost:4000

#Usage

Minimum Example: https://github.com/oboard/mocket_example

#Features

#Dynamic Routes

Support named parameters with :param syntax:

app.get("/hello/:name", fn(event) {
  let name = event.params.get("name").or("World")
  Text("Hello, \{name}!")
})

#Wildcard Routes

Support single and double wildcards:

// Single wildcard - matches one path segment
app.get("/hello/*", fn(event) {
  let name = event.params.get("_").or("World")
  Text("Hello, \{name}!")
})

// Double wildcard - matches multiple path segments
app.get("/hello/**", fn(event) {
  let path = event.params.get("_").or("")
  Text("Hello, \{path}!")
})

#Async Support

The library supports async/await for I/O operations:

#Async /GET Example

// async json data example
app.get("/async_data", async fn(event) {
  Json({ "name": "John Doe", "age": 30, "city": "New York" })
})

#Route Groups

Group related routes under a common base path with shared middleware:

app.group("/api", group => {
  // Add group-level middleware
  group.use_middleware(event => println(
    "🔒 API Group Middleware: \{event.req.reqMethod} \{event.req.url}",
  ))

  // Routes under /api prefix
  group.get("/hello", _ => Text("Hello from API!"))
  group.get("/users", _ => Json({ "users": ["Alice", "Bob"] }))
  group.post("/data", e => e.req.body)
})

This creates routes:

GET /api/hello
GET /api/users
POST /api/data

All routes in the group will execute the group middleware in addition to any global middleware.

#Example usage

let app = @mocket.new(logger=@mocket.new_debug_logger())

  // Register global middleware
  app
  ..use_middleware(event => println(
    "📝 Request: \{event.req.http_method} \{event.req.url}",
  ))

  // Text Response
  ..get("/", _event => Text("⚡️ Tadaa!"))

  // Hello World
  ..on("GET", "/hello", _ => Text("Hello world!"))
  ..group("/api", group => {
    // 添加组级中间件
    group.use_middleware(event => println(
      "🔒 API Group Middleware: \{event.req.http_method} \{event.req.url}",
    ))
    group.get("/hello", _ => Text("Hello world!"))
    group.get("/json", _ => Json({
      "name": "John Doe",
      "age": 30,
      "city": "New York",
    }))
  })

  // JSON Response
  ..get("/json", _event => Json({
    "name": "John Doe",
    "age": 30,
    "city": "New York",
  }))

  // Async Response
  ..get("/async_data", async fn(_event) noraise {
    Json({ "name": "John Doe", "age": 30, "city": "New York" })
  })

  // Dynamic Routes
  // /hello2/World = Hello, World!
  ..get("/hello/:name", fn(event) {
    let name = event.params.get("name").unwrap_or("World")
    Text("Hello, \{name}!")
  })
  // /hello2/World = Hello, World!
  ..get("/hello2/*", fn(event) {
    let name = event.params.get("_").unwrap_or("World")
    Text("Hello, \{name}!")
  })

  // Wildcard Routes
  // /hello3/World/World = Hello, World/World!
  ..get("/hello3/**", fn(event) {
    let name = event.params.get("_").unwrap_or("World")
    Text("Hello, \{name}!")
  })

  // Echo Server
  ..post("/echo", e => e.req.body)

  // 404 Page
  ..get("/404", e => {
    e.res.status_code = 404
    HTML(
      (
        #|<html>
        #|<body>
        #|  <h1>404</h1>
        #|</body>
        #|</html>
      ),
    )
  })

  // Serve
  ..serve(port=4000)

  // Print Server URL
  for path in app.mappings.keys() {
    println("\{path.0} http://localhost:4000\{path.1}")
  }

#Route Matching Examples

Route Pattern	URL	Parameters
/hello/:name	/hello/world	name: "world"
/hello/*	/hello/world	_: "world"
/hello/**	/hello/foo/bar	_: "foo/bar"
/users/:id/posts/:postId	/users/123/posts/456	id: "123", postId: "456"
/api/**	/api/v1/users/123	_: "v1/users/123"
group("/api", ...).get("/hello")	/api/hello	-
group("/users", ...).get("/:id")	/users/123	id: "123"

🙌快来吧！🙌

QQ 群号：949886784

T

source

typealias Mocket as T

ExecError

source

pub suberror ExecError

impl Show for ExecError

IOError

source

pub suberror IOError

impl Show for IOError

NetworkError

source

pub suberror NetworkError

impl Show for NetworkError

HttpBody

source

pub(all) enum HttpBody {
  Json(Json)
  Text(String)
  HTML(String)
  Bytes(Bytes)
  Empty
}

HttpEvent

source

pub struct HttpEvent {
  req : HttpRequest
  res : HttpResponse
  params : Map[String, String]
}

HttpRequest

source

pub struct HttpRequest {
  http_method : String
  url : String
  headers : Map[String, String]
  body : HttpBody
}

HttpResponse

source

pub(all) struct HttpResponse {
  status_code : Int
  headers : Map[String, String]
}

LogLevel

source

pub enum LogLevel {
  Debug
  Info
  Warn
  Error
}

Logger

source

pub struct Logger {
  enabled : Bool
  level : LogLevel
}

Logger::debug

source

fn Logger::debug(self : Logger, message_fn : () -> String) -> Unit

Logger::debug_str

source

fn Logger::debug_str(self : Logger, message : String) -> Unit

Logger::error

source

fn Logger::error(self : Logger, message_fn : () -> String) -> Unit

Logger::info

source

fn Logger::info(self : Logger, message_fn : () -> String) -> Unit

Logger::route_added

source

fn Logger::route_added(self : Logger, path : String) -> Unit

Logger::route_created

source

fn Logger::route_created(self : Logger, path : String) -> Unit

Logger::route_dynamic

source

fn Logger::route_dynamic(self : Logger, http_method : String, path : String) -> Unit

Logger::route_found

source

fn Logger::route_found(self : Logger, http_method : String, path : String) -> Unit

Logger::route_lookup

source

fn Logger::route_lookup(self : Logger, http_method : String, path : String) -> Unit

Logger::route_merge_existing

source

fn Logger::route_merge_existing(self : Logger, http_method : String) -> Unit

Logger::route_merge_new

source

fn Logger::route_merge_new(self : Logger, http_method : String) -> Unit

Logger::route_not_found

source

fn Logger::route_not_found(self : Logger, path : String) -> Unit

Logger::route_register

source

fn Logger::route_register(self : Logger, http_method : String, path : String) -> Unit

Logger::route_static

source

fn Logger::route_static(self : Logger, http_method : String, path : String) -> Unit

Logger::routes_available

source

fn Logger::routes_available(self : Logger, routes : Array[String]) -> Unit

Logger::warn

source

fn Logger::warn(self : Logger, message_fn : () -> String) -> Unit

Mocket

source

pub(all) struct Mocket {
  base_path : String
  mappings : Map[(String, String), async (HttpEvent) -> HttpBody noraise]
  middlewares : Array[(String, async (HttpEvent) -> Unit noraise)]
  static_routes : Map[String, Map[String, async (HttpEvent) -> HttpBody noraise]]
  dynamic_routes : Map[String, Array[(String, async (HttpEvent) -> HttpBody noraise)]]
  logger : Logger
}

Mocket::all

source

fn Mocket::all(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::connect

source

fn Mocket::connect(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::delete

source

fn Mocket::delete(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::get

source

fn Mocket::get(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::group

source

fn Mocket::group(self : Mocket, base_path : String, configure : (Mocket) -> Unit) -> Unit

Mocket::head

source

fn Mocket::head(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::on

source

fn Mocket::on(self : Mocket, event : String, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::options

source

fn Mocket::options(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::patch

source

fn Mocket::patch(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::post

source

fn Mocket::post(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::put

source

fn Mocket::put(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::serve

source

fn Mocket::serve(self : Mocket, port~ : Int) -> Unit

Mocket::trace

source

fn Mocket::trace(self : Mocket, path : String, handler : async (HttpEvent) -> HttpBody noraise) -> Unit

Mocket::use_middleware

source

fn Mocket::use_middleware(self : Mocket, middleware : async (HttpEvent) -> Unit noraise, base_path? : String) -> Unit

new

source

fn new(base_path? : String, logger? : Logger) -> Mocket

new_debug_logger

source

fn new_debug_logger() -> Logger

new_logger

source

fn new_logger(enabled? : Bool, level? : LogLevel) -> Logger

new_production_logger

source

fn new_production_logger() -> Logger

run

source

fn run(f : async () -> Unit noraise) -> Unit

serve_ffi

source

fn serve_ffi(mocket : Mocket, port~ : Int) -> Unit

suspend

source

async fn[T, E : Error] suspend(f : ((T) -> Unit, (E) -> Unit) -> Unit) -> T raise E

suspend 会中断当前协程的运行。 suspend 会接受一个回调函数，并让这个回调函数来操作中断的协程

Source Files

Site source Report issue Packages Build queue Skills Statistics

mocket

#oboard/mocket

#Quick Start

#JavaScript Backend

#Native Backend

#Usage

#Features

#Dynamic Routes

#Wildcard Routes

#Async Support

#Async /GET Example

#Route Groups

#Example usage

#Route Matching Examples

#T

#ExecError

#IOError

#NetworkError

#HttpBody

#HttpEvent

#HttpRequest

#HttpResponse

#LogLevel

#Logger

#Logger::debug

#Logger::debug_str

#Logger::error

#Logger::info

#Logger::route_added

#Logger::route_created

#Logger::route_dynamic

#Logger::route_found

#Logger::route_lookup

#Logger::route_merge_existing

#Logger::route_merge_new

#Logger::route_not_found

#Logger::route_register

#Logger::route_static

#Logger::routes_available

#Logger::warn

#Mocket

#Mocket::all

#Mocket::connect

#Mocket::delete

#Mocket::get

#Mocket::group

#Mocket::head

#Mocket::on

#Mocket::options

#Mocket::patch

#Mocket::post

#Mocket::put

#Mocket::serve

#Mocket::trace

#Mocket::use_middleware

#new

#new_debug_logger

#new_logger

#new_production_logger

#run

#serve_ffi

#suspend

Source Files

T

ExecError

IOError

NetworkError

HttpBody

HttpEvent

HttpRequest

HttpResponse

LogLevel

Logger

Logger::debug

Logger::debug_str

Logger::error

Logger::info

Logger::route_added

Logger::route_created

Logger::route_dynamic

Logger::route_found

Logger::route_lookup

Logger::route_merge_existing

Logger::route_merge_new

Logger::route_not_found

Logger::route_register

Logger::route_static

Logger::routes_available

Logger::warn

Mocket

Mocket::all

Mocket::connect

Mocket::delete

Mocket::get

Mocket::group

Mocket::head

Mocket::on

Mocket::options

Mocket::patch

Mocket::post

Mocket::put

Mocket::serve

Mocket::trace

Mocket::use_middleware

new

new_debug_logger

new_logger

new_production_logger

run

serve_ffi

suspend