RESTful Todo API with Actix-web and SeaORM. Documented by swagger-ui

Awiteb

Last update: Dec 27, 2022

Overview

RESTful Todo

RESTful Todo API with Actix and SeaORM. Documented by swagger-ui

Prerequisites

Rust

Usage

Clone the repository and run the following commands:

cargo run

Just like that, you have a RESTful API running on your machine.

Documentation

The API documentation is available at http://localhost:8080/docs/swagger/
The OpenAPI specification is available at http://localhost:8080/docs/openapi.json

Environment variables

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`

Soon

License

This project is licensed under the MIT License - see the LICENSE file for details

Code template for a production Web Application using Axum: The AwesomeApp Blueprint for Professional Web Development.

AwesomeApp rust-web-app More info at: https://awesomeapp.dev/rust-web-app/ rust-web-app YouTube episodes: Episode 01 - Rust Web App - Course to Produc

45 Sep 6, 2023

A highly customizable, full scale web backend for web-rwkv, built on axum with websocket protocol.

web-rwkv-axum A axum web backend for web-rwkv, built on websocket. Supports BNF-constrained grammar, CFG sampling, etc., all streamed over network. St

12 Sep 25, 2023

A secure and efficient gateway for interacting with OpenAI's API, featuring load balancing, user request handling without individual API keys, and global access control.

OpenAI Hub OpenAI Hub is a comprehensive and robust tool designed to streamline and enhance your interaction with OpenAI's API. It features an innovat

30 Jun 16, 2023

Rust implementation of the `URLPattern` web API

urlpattern This crate implements the URLPattern web API in Rust. We aim to follow the specification as closely as possible. Contributing We appreciate

40 Dec 14, 2022

A pure Rust implementation of the Web Local Storage API, for use in non-browser contexts

Rust Web Local Storage API A Rust implementation of the Web LocalStorage API, for use in non-browser contexts About the Web Local Storage API MDN docs

10 Nov 28, 2022

An tiny web API for @QuarryProtocol

Warlock Warlock is a tiny web API layer around Quarry Protocol and has endpoints to deserialize Quarry accounts like quarries, miners, and rewarders t

2 May 16, 2022

REST API server that abstracts the need to write CRUD methods by exposing a standardized API to interact with a Postgres database

Basiliq Exposing a Postgres database via a REST API that follows the JSON:API specs. All in all, a tasty API. What is Basiliq Quickstart Ready to use

54 Apr 21, 2022

A Google-like web search engine that provides the user with the most relevant websites in accordance to his/her query, using crawled and indexed textual data and PageRank.

Mini Google Course project for the Architecture of Computer Systems course. Overview: Architecture: We are working on multiple components of the web c

11 Aug 10, 2022

Ergonomic and modular web framework built with Tokio, Tower, and Hyper

axum axum is a web application framework that focuses on ergonomics and modularity. More information about this crate can be found in the crate docume

7.9k Dec 31, 2022

Comments

Tests of phase one

This tests of phase one endpoints #5. This PR cannot be merge before end #7 and #9. After #9 will reduce tests with one command, and after #7 fix this

https://github.com/TheAwiteb/restful_todo/blob/f12103111860387d84539f55008755f02b9122a9/src/tests/register.rs#L21-L24

opened by TheAwiteb 0
API Roadmap
The API Roadmap.

Phase 1

Authentication

[X] Auth register. /api/auth/register POST

[ ] Test.

[X] Docs.

[X] Auth login. /api/auth/login POST

[ ] Test.

[X] Docs.

[X] Auth token revoke. /api/auth/revoke PATCH

[ ] Test.

[X] Docs.

Phase 2

Todos

[ ] Todo create /api/todos POST

[ ] Test.

[ ] Docs.

[ ] Todo get by id /api/todos/{id} GET

[ ] Test.

[ ] Docs.

[ ] Todo list (for user) (With skip and limit) /api/todos GET

[ ] Test.

[ ] Docs.

[ ] Todo delete by id /api/todos/{id} DELETE

[ ] Test.

[ ] Docs.

Phase 3

Utilities

[ ] Todo clear (Delete all) /api/todos DELETE

[ ] Test.

[ ] Docs.

[ ] Todo search by title /api/todos/search GET

[ ] Test.

[ ] Docs.

[ ] Sort todos (by dates and id) /api/todos/search GET

[ ] Test.

[ ] Docs.

[ ] Create sub todos /api/todos/{id}/sub POST

[ ] Test.

[ ] Docs.

[ ] List sub todos /api/todos/{id}/sub GET

[ ] Test.

[ ] Docs.

[ ] Delete all sub todos /api/todos/{id}/sub DELETE

[ ] Test.

[ ] Docs.

[ ] Delete sub todos by id /api/todos/{id}/sub/{sub_id} DELETE

[ ] Test.

[ ] Docs.

Phase 4

Tags

[ ] Todo tag create /api/tags POST

[ ] Test.

[ ] Docs.

[ ] Delete tag by id /api/tags/{id} DELETE

[ ] Test.

[ ] Docs.

[ ] Delete tag from todo /api/todos/{id}/tags/{tag_id} DELETE

[ ] Test.

[ ] Docs.

[ ] Add tag to todo /api/todos/{id}/tags/{tag_id} POST

[ ] Test.

[ ] Docs.

[ ] Rename tag /api/tags/{id} PATCH

[ ] Test.

[ ] Docs.

[ ] List all tags /api/tags GET

[ ] Test.

[ ] Docs.

[ ] List all tags for todo /api/todos/{id}/tags GET

[ ] Test.

[ ] Docs.

[ ] List all todos for tag /api/tags/{id}/todos GET

[ ] Test.

[ ] Docs.

enhancement
opened by TheAwiteb 0

Owner

Awiteb

Some(Programmer { langs: vec!['🦀','🐍'] })

GitHub

RESTful Todo API with Actix-web and SeaORM. Documented by swagger-ui

Related tags

Overview

RESTful Todo

Prerequisites

Usage

Documentation

Environment variables

Soon

License

You might also like...

Code template for a production Web Application using Axum: The AwesomeApp Blueprint for Professional Web Development.

A highly customizable, full scale web backend for web-rwkv, built on axum with websocket protocol.

A secure and efficient gateway for interacting with OpenAI's API, featuring load balancing, user request handling without individual API keys, and global access control.

Rust implementation of the `URLPattern` web API

A pure Rust implementation of the Web Local Storage API, for use in non-browser contexts

An tiny web API for @QuarryProtocol

REST API server that abstracts the need to write CRUD methods by exposing a standardized API to interact with a Postgres database

A Google-like web search engine that provides the user with the most relevant websites in accordance to his/her query, using crawled and indexed textual data and PageRank.

Ergonomic and modular web framework built with Tokio, Tower, and Hyper

Comments

Tests of phase one

API Roadmap

Phase 1

Authentication

Phase 2

Todos

Phase 3

Utilities

Phase 4

Tags

Owner

Awiteb

Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust.

Implementation of the RealWorld backend API spec in Actix, Rust's powerful actor system and most fun web framework.

An API project using Rust, Actix Web and JWT. *WIP*

A simple authentication flow using Rust and Actix-web, with a PostgreSQL database and a sveltekit frontend.

A newsletter with actix-web and sqlx-postgres

Web Application with using Rust(Actix, Diesel and etc)

A (flash) message framework for actix-web. A port to Rust of Django's message framework.

TODO pass transform struct instead of trying to modify particles everywhere.

Sauron is an html web framework for building web-apps. It is heavily inspired by elm.

Hot reload static web server for deploying mutiple static web site with version control.

An API project using Rust, Actix Web and JWT. WIP