Secure & lightweight microservice with a database backend
In this repo, we demonstrate a microservice written in Rust, and connected to a MySQL database. It supports CRUD operations on a database table via a HTTP service interface. The microservice is compiled into WebAssembly (Wasm) and runs in the WasmEdge Runtime, which is a secure and lightweight alternative to natively compiled Rust apps in Linux containers. The WasmEdge Runtime can be managed and orchestrated by container tools such as the Docker, Podman, as well as almost all flavors of Kubernetes. It also works with microservice management frameworks such as Dapr. Checkout this article or this video to learn how the Rust code in this microservice works.
Quickstart with Docker
The easiest way to get started is to use a version of Docker Desktop or Docker CLI with Wasm support.
Then, you just need to type one command.
docker compose up
This will build the Rust source code, run the Wasm server, and startup a MySQL backing database. It also starts a basic STATIC web interface (available at http://localhost:8090). See the Dockerfile and docker-compose.yml files. You can jump directly to the CRUD tests section to interact with the web service.
However, if you want to build and run the microservice app step by step on your own system. Follow the detailed instructions below.
Prerequisites
On Linux, you can use the following commands to install Rust and WasmEdge.
# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
# Install WebAssembly target for Rust
rustup target add wasm32-wasi
# Install WasmEdge
curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install.sh | bash -s -- -e all
source $HOME/.wasmedge/env
Build
Use the following command to build the microservice. A WebAssembly bytecode file (wasm file) will be created.
cargo build --target wasm32-wasi --release
You can run the AOT compiler on the wasm file. It could significantly improvement the performance of compute-intensive applications. This microservice, however, is a network intensitive application. Our use of async HTTP networking (Tokio and hyper) and async MySQL connectors are crucial for the performance of this microservice.
wasmedgec target/wasm32-wasi/release/order_demo_service.wasm order_demo_service.wasm
Run
You can use the wasmedge command to run the wasm application. It will start the server. Make sure that you pass the MySQL connection string as the env variable to the command.
wasmedge --env "DATABASE_URL=mysql://user:[email protected]:3306/mysql" order_demo_service.wasm
CRUD tests
Open another terminal, and you can use the curl command to interact with the web service.
When the microservice receives a GET request to the /init endpoint, it would initialize the database with the orders table.
curl http://localhost:8080/init
When the microservice receives a POST request to the /create_order endpoint, it would extract the JSON data from the POST body and insert an Order record into the database table. For multiple records, use the /create_orders endpoint and POST a JSON array of Order objects.
curl http://localhost:8080/create_orders -X POST -d @orders.json
When the microservice receives a GET request to the /orders endpoint, it would get all rows from the orders table and return the result set in a JSON array in the HTTP response.
curl http://localhost:8080/orders
When the microservice receives a POST request to the /update_order endpoint, it would extract the JSON data from the POST body and update the Order record in the database table that matches the order_id in the input data.
curl http://localhost:8080/update_order -X POST -d @update_order.json
When the microservice receives a GET request to the /delete_order endpoint, it would delete the row in the orders table that matches the id GET parameter.
curl http://localhost:8080/delete_order?id=2
That's it. Feel free to fork this project and use it as a template for your own lightweight microservices!
4 Nov 8, 2022
4.6k Jan 8, 2023
255 Dec 25, 2022
75 Jun 12, 2023
1.4k Dec 29, 2022
1.4k Dec 29, 2022
3 Mar 24, 2022
535 Jan 9, 2023
27 Dec 7, 2022
214 Jan 2, 2023
12 Nov 18, 2022
61 Jan 5, 2023
20 Jan 2, 2023
116 Dec 27, 2022
13 Nov 23, 2022
525 Dec 23, 2022
8.3k Dec 30, 2022
5 Apr 26, 2022
33 Dec 16, 2022