Expand description

micro_http_async

What is it for?

A small, lightweight crate using async to serve web pages or web apis with high performance and low overhead.

How do I use it?

Firstly, install the crate and dependencies:

[dependencies]
micro_http_async = "*"
tokio = "1.11.0"

And if you want to support JSON:

serde_json = "1.0"
serde = {version = "1.0", features = ["derive"]}

This crate is designed to abstract away many of the low level code required to run a safe, asynchronous web server Here is a small example which shows how to route, use asynchronous call backs and load webpage templates from HTML files. For the HTML files included, please go to the repository and check the templates folder. Static files also included. To run the included example (which is the example seen below), run cargo run --example hello_world, and visit 127.0.0.1:8080 Please note this is probably not the final API

Examples

This crate aims only to simplify web api or lightweight web creation - not intended to run full scale web apps like chatrooms or other high intensity applications. It implements a simple asynchronous routing system (Made using hash maps for speed and efficiency) as well as asynchronous file loading and more.

It also supports TLS if security is a requirement through the rustls and tokio-rustls crates.

Changelog v0.1.4: TLS support is now available. See the hello_world example for an example on usage.

Macros

Create Route

Structs

Connection

File Loader

Html Constructor

HTTP Server

JSONResponse

Request

Route

Routes

Enums

DataType

Http Methods

Response

Enum to wrap variables for passing into the HtmlConstructor when constructing a html page

Traits

RouteDef

Type Definitions

Holds all variables to dynamically generate (similar to jinja in python)