https://github.com/piotrfleury/todo-rust-api
My first Rust API
https://github.com/piotrfleury/todo-rust-api
Last synced: 3 months ago
JSON representation
My first Rust API
- Host: GitHub
- URL: https://github.com/piotrfleury/todo-rust-api
- Owner: PiotrFLEURY
- Created: 2023-12-30T17:20:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-06T07:58:38.000Z (about 1 year ago)
- Last Synced: 2024-12-28T05:25:34.672Z (4 months ago)
- Language: Rust
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Todo Rust API
My first Rust API.
It's a simple todo list API with CRUD operations.
This is a Proof of Concept to learn Rust with a practical example.
```mermaid
graph LR
A[HTTP Client] -->|Method & Path & JSON|B[Rust Rest API]
B -->|Queries|C[PostgreSQL database]
C -->|Rows|B
B -->|Status code & JSON|A
```
## Table of contents
- [Todo Rust API](#todo-rust-api)
- [Table of contents](#table-of-contents)
- [Installation](#installation)
- [Rust](#rust)
- [Sources](#sources)
- [Usage](#usage)
- [CURL collection](#curl-collection)
- [Available operations](#available-operations)
- [Schema](#schema)
## Installation
### Rust
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Sources
Clone the repository and run the following command:
```bash
cargo run
```
### Database
This API works with a PostgreSQL database.
First start a Postgres container:
```bash
docker run --name postgres -e POSTGRES_PASSWORD=postgres -d -p 5432:5432 postgres
```
Then connect to the database and run the SQL script in `static/sql/` folder.
```bash
docker exec -it postgres psql -U postgres
```
## Usage
### CURL collection
See Shell script examples in `static/rest/` folder.
### Available operations
| Method | Endpoint | Description |
| --- | --- | --- |
| GET | /todos | Get all todos |
| GET | /todos/:id | Get a todo by id |
| POST | /todos | Create a todo |
| PUT | /todos/:id | Update a todo |
| DELETE | /todos/:id | Delete a todo |
### Schema
```json
{
"id": 1,
"title": "Do something",
"completed": false
}
```