microhttpx 0.3.1

Lightweight HTTP server library for microcontrollers.

netcorelink/microhttpx

Lightweight HTTP server library for microcontrollers

---

netcorelink/microhttpx is a lightweight HTTP server library for microcontrollers.

Install by pip microhttpx

pip install microhttpx

Install by MicroPython microhttpx

For MicroPython, installation is performed by copying microhttpx/* the library files to the device's file system.

example: microhttpx/* - :lib/*

A quick example

Route

from microhttpx.status import StatusOK
from microhttpx import HttpxServer, HttpxRequest, HttpxResponse

server = HttpxServer()

@server.route("/hello", methods=("GET",))
def get_hello(req: HttpxRequest):
  return HttpxResponse.json(req.conn, StatusOK(), {"message": "Hello, world!"})

server.listen(port=8080)

Structs

from microhttpx import HttpxStruct, HttpxField

class GetUsersStruct(HttpxStruct):
    __route__ = "/users/{uuid}"
    __fields__ = {
        "uuid": HttpxField(str, required=True),
        "expand": HttpxField(str, required=False, default="basic"),
    }

    uuid: str
    expand: str

Argument	Type	Default value	Description
field_type	type	str	Field type (str, int, float, bool, etc.). The value is automatically converted during parsing.
required	bool	False	Is the field required. If True and the field is missing, a ValueError is thrown.
default	any	None	The default value for an optional field. is used if no value is passed.
validator	Callable[[any], bool]	None	A function to check the value of a field. It should return True if the value is valid. If False, an error is thrown.

usage struct in route:

@server.route("/users/{uuid}")
def get_user(req: HttpxRequest):
    try:
        user = GetUsersStruct(req)
    except ValueError as e:
        return {"error": str(e)}

    return HttpxResponse.json(req.conn, StatusOK(), {"message": {"uuid": user.uuid, "expand": user.expand}})

microhttpx is not a complete replacement for full-fledged server frameworks (Flask, FastAPI, etc.)