🥮 mooncakes.io
    Sign in

    moonbitstack/moonapi/endpoint does not have a README file

    Endpoint

    source
    pub(all) struct Endpoint {
      params : Array[Param]
      request_body : 
    Schema    ?
      request_required : Bool
      request_examples : Map[String, Example]
      responses : Array[ResponseSpec]
    } derive(Eq)

    The runtime endpoint descriptor a route can carry — the one first-class value that replaces FastAPI reading a handler's signature. Walked once for the OpenAPI operation (parameters + requestBody + responses, with every named object hoisted into components/schemas) and for request validation.

    Endpoint::equal

    source
    fn Endpoint::equal(Endpoint, Endpoint) -> Bool

    Endpoint::new

    source
    fn Endpoint::new(params? : Array[Param], request_body? : 
    Schema    , request_required? : Bool, request_examples? : Map[String, Example], responses? : Array[ResponseSpec]) -> Endpoint

    Build an endpoint descriptor. Everything is optional: a bare Endpoint::new() describes an endpoint with no parameters, no body, and (on emit) a default 200 OK response.

    Endpoint::not_equal

    source
    fn Endpoint::not_equal(x : Endpoint, y : Endpoint) -> Bool

    Endpoint::validate

    source

    Validate an inbound request ctx against this endpoint descriptor: every declared parameter (path / query / header / cookie) plus the JSON request body, all off the same descriptor tree that emits the OpenAPI operation. Returns the accumulated errors — an empty array means the request conforms, otherwise pass them to unprocessable for a FastAPI-shaped 422.

    Example

    source
    pub(all) struct Example {
      summary : String
      description : String
      value : Json?
      external_value : String
    } derive(Eq)

    A named example of a value (the OpenAPI Example Object, ← FastAPI's openapi_examples): a summary and a description for the reader, and either the value itself or an external_value URL where it can be fetched. Documentation viewers offer the examples of a parameter or a body by name.

    Example::equal

    source
    fn Example::equal(Example, Example) -> Bool

    Example::new

    source
    fn Example::new(value? : Json, summary? : String, description? : String, external_value? : String) -> Example

    Example::not_equal

    source
    fn Example::not_equal(x : Example, y : Example) -> Bool

    Example::to_json

    source
    fn Example::to_json(self : Example) -> Json

    The Example Object for example. value and externalValue exclude each other, so a value given in both forms is written as the value.

    Param

    source
    pub(all) struct Param {
      name : String
      loc : ParamLoc
      schema : 
    Schema
      required : Bool
      description : String
      constraints : Array[
    Constraint    ]
      default : Json?
      alias_ : String
      examples : Map[String, Example]
    } derive(Eq)

    A single request parameter descriptor: its name, location, scalar schema, whether it is required, an optional description, its value constraints, the default that stands in when the request omits it, and the alias it travels under on the wire. Path parameters are always required (OpenAPI requires it); the constructor keeps the caller's value but validation treats path params as mandatory.

    Param::equal

    source
    fn Param::equal(Param, Param) -> Bool

    Param::is_required

    source
    fn Param::is_required(self : Param) -> Bool

    Whether a request must carry this parameter. One with a default never must — its absence is answered by the default, exactly as a Python default argument is.

    Param::key

    source
    fn Param::key(self : Param) -> String

    The name this parameter travels under: its alias when it has one, else its own name. This is what is read off the request, what the document calls it, and what a validation error's loc points at — all three being the client's view of the parameter.

    Param::new

    source
    fn Param::new(name : String, loc : ParamLoc, schema? : 
    Schema    , required? : Bool, description? : String, constraints? : Array[
    Constraint    ], default? : Json, alias_? : String, examples? : Map[String, Example]) -> Param

    Build a parameter descriptor. schema defaults to a string and required to true. constraints are the Pydantic-style bounds FastAPI reads off a Query(ge=…, max_length=…) — emitted into the parameter's documented schema and enforced on the inbound value. default is emitted and makes the parameter optional, since a value that has one is never missing. alias is the name the parameter travels under when that differs from the one the code calls it (← Query(alias="item-query")). examples are offered by name in the documentation (← Query(openapi_examples=…)).

    Param::not_equal

    source
    fn Param::not_equal(x : Param, y : Param) -> Bool

    ParamLoc

    source
    pub(all) enum ParamLoc {
      InPath
      InQuery
      InHeader
      InCookie
    } derive(Eq)

    Where a parameter is carried, the OpenAPI in locations: the path, the query string, a header, or a cookie.

    ParamLoc::equal

    source
    fn ParamLoc::equal(ParamLoc, ParamLoc) -> Bool

    ParamLoc::not_equal

    source
    fn ParamLoc::not_equal(x : ParamLoc, y : ParamLoc) -> Bool

    ResponseSpec

    source
    pub(all) struct ResponseSpec {
      status : Int
      description : String
      body : 
    Schema    ?
      examples : Map[String, Example]
    } derive(Eq)

    A single response descriptor: the HTTP status, a human description, an optional body schema (None for an empty body, e.g. 204), and named examples of that body.

    ResponseSpec::equal

    source

    ResponseSpec::new

    source
    fn ResponseSpec::new(status : Int, description? : String, body? : 
    Schema    , examples? : Map[String, Example]) -> ResponseSpec

    Build a response descriptor. description defaults to "OK" and there is no body unless one is given.

    ResponseSpec::not_equal

    source
    fn ResponseSpec::not_equal(x : ResponseSpec, y : ResponseSpec) -> Bool

    loc_str

    source
    fn loc_str(l : ParamLoc) -> String

    The OpenAPI in string for a location.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io