rustapi

RESTful API template built with Rust lang. It uses MongoDB database and Axum HTTP framework.

Requirements

Rust
MongoDB

How to

To use this template as your project starting point, click "Use this template" at the top of this page, or click here.

Features

Authentication. Based on jsonwebtoken
Layered configuration system. Based on config-rs
Logs. Based on tracing
Error handling
CI Jobs based on Github actions
E2E Tests
Dependabot configuration

Project structure

├── Cargo.toml
├── README.md
├── config
│   ├── default.json    # Default configuration
│   └── production.json # Production configuration (Overwrites the default)
├── rustfmt.toml
└── src
    ├── context.rs      # Shared state and functionality across the APP
    ├── database.rs
    ├── errors.rs
    ├── lib             # Helpers not related to the business model
    │   ├── authenticate_request.rs
    │   ├── date.rs
    │   ├── mod.rs
    │   ├── models.rs   # Base Database Model trait
    │   ├── to_object_id.rs
    │   └── token.rs
    ├── logger.rs
    ├── main.rs
    ├── models
    │   ├── cat.rs
    │   ├── mod.rs
    │   └── user.rs
    ├── routes
    │   ├── cat.rs
    │   ├── mod.rs
    │   └── user.rs
    └── settings.rs

Contributing