https://github.com/theawiteb/oxide_todo
RESTful Todo API with Actix-web and SeaORM. Documented by swagger-ui
https://github.com/theawiteb/oxide_todo
actix-web openapi rust sea-orm swagger-ui
Last synced: 11 months ago
JSON representation
RESTful Todo API with Actix-web and SeaORM. Documented by swagger-ui
- Host: GitHub
- URL: https://github.com/theawiteb/oxide_todo
- Owner: TheAwiteb
- License: mit
- Created: 2022-11-17T13:03:25.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T12:21:33.000Z (almost 3 years ago)
- Last Synced: 2025-03-16T23:42:05.952Z (11 months ago)
- Topics: actix-web, openapi, rust, sea-orm, swagger-ui
- Language: Rust
- Homepage:
- Size: 352 KB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Oxide Todo
Oxide Todo is RESTful API built with [Actix](https://actix.rs) and [SeaORM](https://www.sea-ql.org/). Documented by [swagger-ui](https://swagger.io/). Authenticated by [JWT](https://jwt.io/). Rate limited by [actix_extensible_rate_limit](https://crates.io/crates/actix_extensible_rate_limit). Tested by [rstest](https://crates.io/crates/rstest). Have fun! 😁
[](https://github.com/TheAwiteb/oxide_todo/actions/workflows/CI.yaml)
### Prerequisites
- [Rust](https://www.rust-lang.org/tools/install) (Minimum Supported Rust Version: 1.65.0)
### Usage
Clone the repository and run the following commands:
```bash
cargo run
```
Just like that, you have a RESTful API running on your machine.
If you want to see the logs, you can run the following command:
```bash
RUST_LOG=debug cargo run
```
### Documentation
- The API documentation is available at `{HOST}:{PORT}/docs/swagger/` (default: )
- The OpenAPI specification is available at `{HOST}:{PORT}/docs/openapi.json` (default: )
### Environment variables
Rename the `.env.example` file to `.env` and change the values to your needs. Empty default means that the variable is required.
| Name | Description | Default |
| --- | --- | --- |
| `DATABASE_URL` | The database url | `sqlite://db.sqlite3` |
| `SECRET_KEY` | The secret key for JWT | ` ` |
| `HOST` | The host to bind | `localhost` |
| `PORT` | The port to run the server | `8080` |
| `RATE_LIMIT_BURST_SIZE` | The burst size for rate limiter | `30` |
| `RATE_LIMIT_PER_SECOND` | The time to reset the burst | `60` |
| `API_CONTACT_NAME` | The name of the API contact | ` ` |
| `API_CONTACT_URL` | The url of the API contact | ` ` |
| `API_CONTACT_EMAIL` | The email of the API contact | ` ` |
| `API_TITLE` | The title of the API | `RESTful Todo API documentation` |
### Testing
#### Prerequisites
- [dotenv-cli](https://pypi.org/project/dotenv-cli/)
- [just](https://github.com/casey/just)
```bash
just tests
```
### Development
For development you need to install [just](https://github.com/casey/just) and [dotenv-cli](https://pypi.org/project/dotenv-cli/).
With `just` you can run all needed commands with one command, type `just` folloing by the command you want to run.
Available commands:
- `just build` to build the RESTful API
- `just ci` to run the CI
- `just fmt` to format everything
- `just fmt-check` to check the format of everything
- `just linter` to run Rust linter (clippy)
- `just tests` to run the tests
## Soon
- [X] Swagger UI for API documentation
- [X] Rate limiting
- [X] CI with Github Actions
- [X] Unit tests
- [ ] Dockerize the server
- [X] JustFile for easy setup, useing [just](https://github.com/casey/just)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details