https://github.com/ndelvalle/rustapi

🚀 RESTful Rust API Template / Boilerplate
https://github.com/ndelvalle/rustapi

api axum boilerplate mongodb restful rust starter-template

Last synced: 10 days ago
JSON representation

🚀 RESTful Rust API Template / Boilerplate

• Host: GitHub
• URL: https://github.com/ndelvalle/rustapi
• Owner: ndelvalle
• Created: 2019-10-17T17:21:47.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T10:02:35.000Z (about 1 month ago)
• Last Synced: 2024-10-12T09:23:54.921Z (29 days ago)
• Topics: api, axum, boilerplate, mongodb, restful, rust, starter-template
• Language: Rust
• Homepage:
• Size: 671 KB
• Stars: 455
• Watchers: 5
• Forks: 56
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# rustapi

[![Tests](https://github.com/ndelvalle/rustapi/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/ndelvalle/rustapi/actions/workflows/test.yml)

RESTful API template built with Rust lang. It uses [MongoDB](https://docs.mongodb.com/)

database and [Axum](https://github.com/tokio-rs/axum) HTTP framework.

### Requirements

- [Rust](https://www.rust-lang.org/tools/install)

- [MongoDB](https://docs.mongodb.com/manual/installation/)

### How to use this template

To use this template as your project starting point, click "Use this template" at the top of this page, or click [here](https://github.com/ndelvalle/rustapi/generate).

### Feature highlights

* Authentication. Based on [jsonwebtoken](https://github.com/Keats/jsonwebtoken)

* Layered configuration. Based on [config-rs](https://github.com/mehcode/config-rs)

* Logs. Based on [tracing](https://github.com/tokio-rs/tracing)

* Error handling

* Pagination

* E2E Tests

* OpenAPI Specification

* CI based on Github actions

* Dependabot configuration

### Project structure

```bash

├── Cargo.lock

├── Cargo.toml

├── README.md

├── config

│   ├── default.json    # Default configuration

│   ├── production.json # Production configuration (Overwrites the default)

│   └── test.json       # Test configuration (Overwrites the default)

├── rustfmt.toml

├── src

│   ├── 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

│   │   ├── status.rs

│   │   └── user.rs

│   ├── settings.rs

│   └── tests           # E2E Tests

└── test.sh

```

### Test

To run tests make sure MongoDB is up and running.

```

make test

``` 

## Contributing

Contributors are welcome, please fork and send pull requests! If you find a bug

or have any ideas on how to improve this project please submit an issue.