Code Monkey home page Code Monkey logo

rust-rocket-sample's Introduction

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

rust-rocket-sample's People

Contributors

taeyoonkwon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

rust-rocket-sample's Issues

rocket_okapi error when running with cargo run

Hi, when I try to run this project I receive the following error from cargo run

Compiling rocket_okapi v0.8.0-rc.1
error[E0432]: unresolved import `rocket::response::content::Custom`
 --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/handlers/content.rs:2:24
  |
2 | use rocket::response::{content::Custom, Responder};
  |                        ^^^^^^^^^^^^^^^ no `Custom` in `response::content`

error[E0432]: unresolved import `rocket::response::content::Custom`
 --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/handlers/openapi.rs:3:5
  |
3 | use rocket::response::content::Custom;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `Custom` in `response::content`

error[E0412]: cannot find type `Css` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:216:27
    |
216 | response_content_wrapper!(Css, "text/css");
    |                           ^^^ not found in `rocket::response::content`

error[E0412]: cannot find type `Custom` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:217:27
    |
217 | response_content_wrapper!(Custom, "*/*");
    |                           ^^^^^^ not found in `rocket::response::content`
    |
help: consider importing this struct
    |
1   | use rocket::response::status::Custom;
    |
help: if you import `Custom`, refer to it directly
    |
205 -             for rocket::response::content::$responder<T>
205 +             for ::response::content::$responder<T>
    | 

error[E0412]: cannot find type `Html` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:218:27
    |
218 | response_content_wrapper!(Html, "text/html");
    |                           ^^^^ not found in `rocket::response::content`

error[E0412]: cannot find type `JavaScript` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:219:27
    |
219 |   response_content_wrapper!(JavaScript, "application/javascript");
    |                             ^^^^^^^^^^ help: a struct with a similar name exists: `RawJavaScript`
    |
   ::: /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket-0.5.0-rc.2/src/response/content.rs:69:1
    |
69  | / ctrs! {
70  | |     // FIXME: Add a note that this is _not_ `serde::Json`.
71  | |     RawJson: JSON, "JSON", "application/json",
72  | |     RawXml: XML, "XML", "text/xml",
...   |
77  | |     RawJavaScript: JavaScript, "JavaScript", "application/javascript"
78  | | }
    | |_- similarly named struct `RawJavaScript` defined here

error[E0412]: cannot find type `Json` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:220:27
    |
220 | response_content_wrapper!(Json, "application/json");
    |                           ^^^^ not found in `rocket::response::content`
    |
help: consider importing this struct
    |
1   | use rocket::serde::json::Json;
    |
help: if you import `Json`, refer to it directly
    |
205 -             for rocket::response::content::$responder<T>
205 +             for ::response::content::$responder<T>
    | 

error[E0412]: cannot find type `MsgPack` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:221:27
    |
221 | response_content_wrapper!(MsgPack, "application/msgpack");
    |                           ^^^^^^^ not found in `rocket::response::content`

error[E0412]: cannot find type `Plain` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:222:27
    |
222 | response_content_wrapper!(Plain, "text/plain");
    |                           ^^^^^ not found in `rocket::response::content`

error[E0412]: cannot find type `Xml` in module `rocket::response::content`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/response/responder_impls.rs:223:27
    |
223 | response_content_wrapper!(Xml, "text/xml");
    |                           ^^^ not found in `rocket::response::content`

error[E0283]: type annotations needed
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/swagger_ui.rs:136:24
    |
136 |         config_handler.into_route("/swagger-ui-config.json"),
    |                        ^^^^^^^^^^ cannot infer type for type parameter `R`
    |
help: type parameter declared here
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/handlers/content.rs:44:6
    |
44  | impl<R: AsRef<[u8]> + Clone + Send + Sync + 'static> ContentHandler<R> {
    |      ^
    = note: cannot satisfy `_: AsRef<[u8]>`
note: required by a bound in `handlers::content::ContentHandler::<R>::into_route`
   --> /home/mble/.cargo/registry/src/github.com-1ecc6299db9ec823/rocket_okapi-0.8.0-rc.1/src/handlers/content.rs:44:9
    |
44  | impl<R: AsRef<[u8]> + Clone + Send + Sync + 'static> ContentHandler<R> {
    |         ^^^^^^^^^^^ required by this bound in `handlers::content::ContentHandler::<R>::into_route`
45  |     /// Create a `rocket::Route` from the current `ContentHandler`.
46  |     pub fn into_route(self, path: impl AsRef<str>) -> Route {
    |            ---------- required by a bound in this

Some errors have detailed explanations: E0283, E0412, E0432.
For more information about an error, try `rustc --explain E0283`.
error: could not compile `rocket_okapi` due to 11 previous errors

rust - cargo 1.63.0-nightly (39ad1039d 2022-05-25)
os - Arch Linux
host - 20F5S5270S ThinkPad X260
kernel - 5.17.9-zen1-1-zen

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.