Skip to content

Fully working CRUD REST API example using Rust and Rocket.rs

License

Notifications You must be signed in to change notification settings

hgatos/rust-rocket-sample

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rust-rocket-sample

CI

Fully working CRUD REST API example using

  • Rust (stable)
  • Rocket.rs
  • mongodb
  • okapi

🚀 Features

  • Establish MongoDB connection using rocket Adhoc fairing.
  • Custom error handlings with rocket Responder and okapi OpenApiGenerator.
  • CORS fairing and Counter fairing to demonstrate how fairing works.
  • Example model Customer to demonstrate how Rust structs interact with MongoDB.
  • Request guard using ApiKey.
  • REST API endpoints with simple CRUD using Customer model.
  • Implement Open API documentation using okapi.
  • Test codes to test API endpoints.

🔧 Building and Testing

debug mode

cargo run

release mode

cargo build --release && cargo run --release

unit testing

cargo test


ℹ️ You should create your own .env file including MONGO_URI, MONGO_DB_NAME, and API_KEY to run it.

📑 License

MIT Copyright (c) 2022 Taeyoon Kwon

About

Fully working CRUD REST API example using Rust and Rocket.rs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 98.5%
  • Dockerfile 1.5%