README
U
T
T
HttpEvent
T
HttpRequest
- ::headersHttpRequestInternal::headers
- ::onHttpRequestInternal::on
- ::req_methodHttpRequestInternal::req_method
- ::urlHttpRequestInternal::url
T
HttpResponse
- ::endHttpResponseInternal::end
- ::statusCodeHttpResponseInternal::statusCode
- ::urlHttpResponseInternal::url
- ::write_headHttpResponseInternal::write_head
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
- ::outputURL::output
- ::parseURL::parse
- ::to_stringURL::to_string
V
createServer
V
html
V
json
V
new
V
new_debug_logger
V
new_logger
V
new_production_logger
V
run
V
suspend
V
text

mocket

A web framework for MoonBit.

http

server

Download zip

Author

oboard

Version

0.4.2

License

Apache-2.0

Repository

github.com/oboard/mocket

Last updated

last year

Downloads

#oboard/mocket

A web framework for MoonBit.

#Quick Start

It's necessary to set the backend of MoonBit to js in Visual Studio Code

Command: MoonBit: Select Backend -> js

moon run src/main/main.mbt --target js

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")
  "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")
  "Hello, \{name}!"
})

// Double wildcard - matches multiple path segments
app.get("/hello/**", fn(event) {
  let path = event.params.get("_").or("")
  "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) {
  { "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", _ => "Hello from API!")
  group.get("/users", _ => { "users": ["Alice", "Bob"] })
  group.post("/data", e => e.req.body.to_json())
})

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

fn main {

  let app = @mocket.new()

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

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

  // Route Groups with middleware
  ..group("/api", group => {
    // Add group-level middleware
    group.use_middleware(event => println(
      "🔒 API Group Middleware: \{event.req.reqMethod} \{event.req.url}",
    ))
    group.get("/hello", _ => "Hello from API!")
    group.get("/json", _ => {
      "name": "John Doe",
      "age": 30,
      "city": "New York",
    })
  })

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

  // Async Response
  ..get("/async_data", async fn(_event) {
    { "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").or("World")
    "Hello, \{name}!"
  })
  // /hello2/World = Hello, World!
  ..get("/hello2/*", fn(event) {
    let name = event.params.get("_").or("World")
    "Hello, \{name}!"
  })

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

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

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

  // Serve
  ..serve(port=4000)

  // Print Server URL
  for path in app.mappings.keys() {
    println("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

HttpEvent

source

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

HttpRequest

source

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

HttpRequestInternal

source

#external
pub type HttpRequestInternal

HttpRequestInternal::headers

source

fn HttpRequestInternal::headers(self : HttpRequestInternal) -> @rami3l/js-ffi/js.Object
Object

HttpRequestInternal::on

source

fn HttpRequestInternal::on(self : HttpRequestInternal, event : String, handler : (@rami3l/js-ffi/js.Value
Value) -> Unit) -> Unit

HttpRequestInternal::req_method

source

fn HttpRequestInternal::req_method(self : HttpRequestInternal) -> String

HttpRequestInternal::url

source

fn HttpRequestInternal::url(self : HttpRequestInternal) -> String

HttpResponse

source

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

HttpResponseInternal

source

#external
pub type HttpResponseInternal

HttpResponseInternal::end

source

fn HttpResponseInternal::end(self : HttpResponseInternal, data : String) -> Unit

HttpResponseInternal::statusCode

source

fn HttpResponseInternal::statusCode(self : HttpResponseInternal) -> Int

HttpResponseInternal::url

source

fn HttpResponseInternal::url(self : HttpResponseInternal) -> String

HttpResponseInternal::write_head

source

fn HttpResponseInternal::write_head(self : HttpResponseInternal, statusCode : Int, headers : @rami3l/js-ffi/js.Value
Value) -> Unit

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, method_ : String, path : String) -> Unit

Logger::route_found

source

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

Logger::route_lookup

source

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

Logger::route_merge_existing

source

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

Logger::route_merge_new

source

fn Logger::route_merge_new(self : Logger, 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, method_ : String, path : String) -> Unit

Logger::route_static

source

fn Logger::route_static(self : Logger, 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) -> Json]
  middlewares : Array[(String, async (HttpEvent) -> Unit)]
  static_routes : Map[String, Map[String, async (HttpEvent) -> Json]]
  dynamic_routes : Map[String, Array[(String, async (HttpEvent) -> Json)]]
  logger : Logger
}

Mocket::all

source

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

Mocket::connect

source

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

Mocket::delete

source

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

Mocket::get

source

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

Mocket::on

source

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

Mocket::options

source

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

Mocket::patch

source

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

Mocket::post

source

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

Mocket::put

source

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

Mocket::use_middleware

source

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

URL

source

pub struct URL {
  protocol : String?
  host : String?
  port : Int?
  path : String
  query : Map[String, String]?
  fragment : String?
}

impl Show for URL

URL::output

source

fn URL::output(self : URL, logger : Logger) -> Unit

URL::parse

source

fn URL::parse(rawUrl : String) -> URL

URL::to_string

source

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

createServer

source

fn createServer(handler : (HttpRequestInternal, HttpResponseInternal, () -> Unit) -> Unit, port : Int) -> Unit

html

source

fn html(body : String) -> Json

json

source

fn json(body : Json) -> Json

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) -> Unit

suspend

source

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

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

text

source

fn text(body : String) -> Json

Source Files

Site source Report issue Packages Build queue Skills Statistics

mocket

#oboard/mocket

#Quick Start

#Usage

#Features

#Dynamic Routes

#Wildcard Routes

#Async Support

#Async /GET Example

#Route Groups

#Example usage

#Route Matching Examples

#T

#ExecError

#IOError

#NetworkError

#HttpEvent

#HttpRequest

#HttpRequestInternal

#HttpRequestInternal::headers

#HttpRequestInternal::on

#HttpRequestInternal::req_method

#HttpRequestInternal::url

#HttpResponse

#HttpResponseInternal

#HttpResponseInternal::end

#HttpResponseInternal::statusCode

#HttpResponseInternal::url

#HttpResponseInternal::write_head

#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

#URL

#URL::output

#URL::parse

#URL::to_string

#createServer

#html

#json

#new

#new_debug_logger

#new_logger

#new_production_logger

#run

#suspend

#text

Source Files

T

ExecError

IOError

NetworkError

HttpEvent

HttpRequest

HttpRequestInternal

HttpRequestInternal::headers

HttpRequestInternal::on

HttpRequestInternal::req_method

HttpRequestInternal::url

HttpResponse

HttpResponseInternal

HttpResponseInternal::end

HttpResponseInternal::statusCode

HttpResponseInternal::url

HttpResponseInternal::write_head

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

URL

URL::output

URL::parse

URL::to_string

createServer

html

json

new

new_debug_logger

new_logger

new_production_logger

run

suspend

text