README
U
HttpHandler
U
Middleware
U
WebSocketHandler
T
CookieItem
- ::content_typeHttpBody::content_type
- ::get_cookieHttpRequest::get_cookie
- ::on_completeHttpRequestInternal::on_complete
- ::on_headersHttpRequestInternal::on_headers
- ::delete_cookieHttpResponse::delete_cookie
- ::set_cookieHttpResponse::set_cookie
T
HttpResponseInternal
T
HttpServerInternal
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
- ::wsMocket::ws
T
MocketEvent
T
MultipartFormValue
T
SameSiteOption
T
WebSocketEvent
- ::publishWebSocketPeer::publish
- ::sendWebSocketPeer::send
- ::subscribeWebSocketPeer::subscribe
- ::to_stringWebSocketPeer::to_string
- ::unsubscribeWebSocketPeer::unsubscribe
V
__ws_emit
V
async_run
V
cookie_to_string
V
execute_middlewares
V
form_encode
V
new
V
new_debug_logger
V
new_logger
V
new_production_logger
V
parse_cookie
V
parse_form_data
V
parse_multipart
V
register_ws_handler
V
serve_ffi
V
suspend
V
url_decode
V
url_encode
V
ws_publish
V
ws_send
V
ws_subscribe
V
ws_unsubscribe

mocket

A web framework for MoonBit.

http

server

Download zip

Author

oboard

Version

0.5.8

License

Apache-2.0

Repository

github.com/oboard/mocket

Last updated

11 months ago

Downloads

#oboard/mocket

A web framework for MoonBit.

👉 Documentation

#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", 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/*", event => {
  let name = event.params.get("_").or("World")
  Text("Hello, \{name}!")
})

// Double wildcard - matches multiple path segments
app.get("/hello/**", 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", event => {
    let name = event.params.get("name").unwrap_or("World")
    Text("Hello, \{name}!")
  })
  // /hello2/World = Hello, World!
  ..get("/hello2/*", event => {
    let name = event.params.get("_").unwrap_or("World")
    Text("Hello, \{name}!")
  })

  // Wildcard Routes
  // /hello3/World/World = Hello, World/World!
  ..get("/hello3/**", 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"

#Q & A

#Why not moonbitlang/async ?

moonbitlang/async is a great library, but it is not supported by the js backend.

🙌快来吧！🙌

QQ 群号：949886784

HttpHandler

source

type HttpHandler = async (MocketEvent) -> HttpBody noraise

Middleware

source

type Middleware = async (MocketEvent, async () -> HttpBody noraise) -> HttpBody noraise

WebSocketHandler

source

type WebSocketHandler = (WebSocketEvent) -> Unit

BodyError

source

pub suberror BodyError {
  InvalidJsonCharset
  InvalidJson
  InvalidText
}

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

CookieItem

source

pub(all) struct CookieItem {
  name : String
  value : String
  max_age : Int?
  path : String?
  domain : String?
  secure : Bool?
  http_only : Bool?
  same_site : SameSiteOption?
}

impl Eq for CookieItem

impl Show for CookieItem

HttpBody

source

pub(all) enum HttpBody {
  Json(Json)
  Text(StringView)
  HTML(StringView)
  Bytes(BytesView)
  Form(Map[String, String])
  Multipart(Map[String, MultipartFormValue])
  Empty
}

HttpBody::content_type

source

fn HttpBody::content_type(self : HttpBody, boundary? : String) -> String

HttpRequest

source

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

HttpRequest::get_cookie

source

fn HttpRequest::get_cookie(self : HttpRequest, name : String) -> CookieItem?

HttpRequestInternal

source

#external
pub type HttpRequestInternal

HttpRequestInternal::on_complete

source

fn HttpRequestInternal::on_complete(self : HttpRequestInternal, cb : FuncRef[() -> Unit]) -> Unit

HttpRequestInternal::on_headers

source

fn HttpRequestInternal::on_headers(self : HttpRequestInternal, cb : FuncRef[(@illusory0x0/native.CStr
CStr) -> Unit]) -> Unit

HttpResponse

source

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

HttpResponse::delete_cookie

source

fn HttpResponse::delete_cookie(self : HttpResponse, key : String) -> Unit

HttpResponse::set_cookie

source

fn HttpResponse::set_cookie(self : HttpResponse, name : String, value : String, max_age? : Int, path? : String, domain? : String, secure? : Bool, http_only? : Bool, same_site? : SameSiteOption) -> Unit

HttpResponseInternal

source

#external
pub type HttpResponseInternal

HttpServerInternal

source

#external
pub type HttpServerInternal

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

#alias(T)
pub(all) struct Mocket {
  base_path : String
  mappings : Map[(String, String), async (MocketEvent) -> HttpBody noraise]
  middlewares : Array[(String, async (MocketEvent, async () -> HttpBody noraise) -> HttpBody noraise)]
  static_routes : Map[String, Map[String, async (MocketEvent) -> HttpBody noraise]]
  dynamic_routes : Map[String, Array[(String, async (MocketEvent) -> HttpBody noraise)]]
  logger : Logger
  ws_static_routes : Map[String, (WebSocketEvent) -> Unit]
  ws_dynamic_routes : Array[(String, (WebSocketEvent) -> Unit)]
  ws_clients : Map[String, Unit]
  ws_channels : Map[String, Map[String, Unit]]
  ws_client_port : Map[String, Int]
}

Mocket::all

source

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

Mocket::connect

source

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

Mocket::delete

source

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

Mocket::get

source

fn Mocket::get(self : Mocket, path : String, handler : async (MocketEvent) -> 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 (MocketEvent) -> HttpBody noraise) -> Unit

Mocket::on

source

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

Mocket::options

source

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

Mocket::patch

source

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

Mocket::post

source

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

Mocket::put

source

fn Mocket::put(self : Mocket, path : String, handler : async (MocketEvent) -> 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 (MocketEvent) -> HttpBody noraise) -> Unit

Mocket::use_middleware

source

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

Mocket::ws

source

fn Mocket::ws(self : Mocket, path : String, handler : (WebSocketEvent) -> Unit) -> Unit

MocketEvent

source

pub(all) struct MocketEvent {
  req : HttpRequest
  res : HttpResponse
  params : Map[String, StringView]
}

MultipartFormValue

source

pub(all) struct MultipartFormValue {
  filename : String?
  content_type : String?
  data : BytesView
}

SameSiteOption

source

pub(all) enum SameSiteOption {
  Lax
  Strict
  SameSiteNone
}

impl Eq for SameSiteOption

impl Show for SameSiteOption

impl ToJson for SameSiteOption

WebSocketEvent

source

pub enum WebSocketEvent {
  Open(WebSocketPeer)
  Message(WebSocketPeer, HttpBody)
  Close(WebSocketPeer)
}

WebSocketPeer

source

pub(all) struct WebSocketPeer {
  connection_id : String
  subscribed_channels : Array[String]
}

WebSocketPeer::publish

source

fn WebSocketPeer::publish(channel : String, message : String) -> Unit

WebSocketPeer::send

source

fn WebSocketPeer::send(self : WebSocketPeer, message : String) -> Unit

fn WebSocketPeer::subscribe(self : WebSocketPeer, channel : String) -> Unit

WebSocketPeer::to_string

source

fn WebSocketPeer::to_string(self : WebSocketPeer) -> String

WebSocketPeer::unsubscribe

source

fn WebSocketPeer::unsubscribe(self : WebSocketPeer, channel : String) -> Unit

__ws_emit

source

fn __ws_emit(event_type : @illusory0x0/native.CStr
CStr, connection_id : @illusory0x0/native.CStr
CStr, payload : @illusory0x0/native.CStr
CStr) -> Unit

async_run

source

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

cookie_to_string

source

fn cookie_to_string(cookie : Array[CookieItem]) -> String

execute_middlewares

source

async fn execute_middlewares(middlewares : Array[(String, async (MocketEvent, async () -> HttpBody noraise) -> HttpBody noraise)], event : MocketEvent, final_handler : async (MocketEvent) -> HttpBody noraise) -> HttpBody noraise

form_encode

source

fn form_encode(map : Map[String, String]) -> String

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

parse_cookie

source

fn parse_cookie(cookie : StringView) -> Map[String, CookieItem]

parse_form_data

source

fn parse_form_data(bytes : BytesView) -> Map[String, String]

parse_multipart

source

fn parse_multipart(bytes : BytesView, boundary : String) -> Map[String, MultipartFormValue]

register_ws_handler

source

fn register_ws_handler(mocket : Mocket, port : Int) -> 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 会接受一个回调函数，并让这个回调函数来操作中断的协程

url_decode

source

fn url_decode(bytes : BytesView) -> String

url_encode

source

fn url_encode(s : String) -> String

ws_publish

source

fn ws_publish(channel : String, msg : String) -> Unit

ws_send

source

fn ws_send(id : String, msg : String) -> Unit

ws_subscribe

source

fn ws_subscribe(id : String, channel : String) -> Unit

ws_unsubscribe

source

fn ws_unsubscribe(id : String, channel : String) -> Unit

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

#Q & A

#Why not moonbitlang/async ?

#HttpHandler

#Middleware

#WebSocketHandler

#BodyError

#ExecError

#IOError

#NetworkError

#CookieItem

#HttpBody

#HttpBody::content_type

#HttpRequest

#HttpRequest::get_cookie

#HttpRequestInternal

#HttpRequestInternal::on_complete

#HttpRequestInternal::on_headers

#HttpResponse

#HttpResponse::delete_cookie

#HttpResponse::set_cookie

#HttpResponseInternal

#HttpServerInternal

#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

#Mocket::ws

#MocketEvent

#MultipartFormValue

#SameSiteOption

#WebSocketEvent

#WebSocketPeer

#WebSocketPeer::publish

#WebSocketPeer::send

#WebSocketPeer::subscribe

#WebSocketPeer::to_string

#WebSocketPeer::unsubscribe

HttpHandler

Middleware

WebSocketHandler

BodyError

ExecError

IOError

NetworkError

CookieItem

HttpBody

HttpBody::content_type

HttpRequest

HttpRequest::get_cookie

HttpRequestInternal

HttpRequestInternal::on_complete

HttpRequestInternal::on_headers

HttpResponse

HttpResponse::delete_cookie

HttpResponse::set_cookie

HttpResponseInternal

HttpServerInternal

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

Mocket::ws

MocketEvent

MultipartFormValue

SameSiteOption

WebSocketEvent

WebSocketPeer

WebSocketPeer::publish

WebSocketPeer::send

WebSocketPeer::subscribe

WebSocketPeer::to_string

WebSocketPeer::unsubscribe

__ws_emit

async_run

cookie_to_string

execute_middlewares

form_encode

new

new_debug_logger

new_logger

new_production_logger

parse_cookie

parse_form_data

parse_multipart

register_ws_handler

serve_ffi

suspend

url_decode