https://github.com/benjaminpla/warp_api
https://github.com/benjaminpla/warp_api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/benjaminpla/warp_api
- Owner: benjaminPla
- Created: 2024-08-06T08:00:03.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-08-06T12:24:14.000Z (10 months ago)
- Last Synced: 2025-02-06T20:01:03.885Z (3 months ago)
- Language: Rust
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Warp API | Rust
## Overview
This project demonstrates a web API built using Warp and Rust. The API uses PostgreSQL for database operations and includes basic user management functionalities with password encryption and JWT authentication. Environment variables are used for configuration, and Warp provides an efficient, asynchronous web framework for handling requests.
## Project Structure
```
.
├── Cargo.lock
├── Cargo.toml
├── README.md
├── src
│ ├── controllers
│ │ └── mod.rs
│ ├── errors
│ │ └── mod.rs
│ ├── helpers
│ │ └── mod.rs
│ ├── main.rs
│ ├── middlewares
│ │ └── mod.rs
│ └── routes
│ └── mod.rs
└── todo.md
```
## Features
- **Password Encryption:** Uses Argon2 for securely hashing and verifying passwords.
- **JWT Authentication:** Implements JSON Web Tokens (JWT) for secure user authentication.
## Database
This project uses PostgreSQL for database operations. To run PostgreSQL in a Docker container, use the following command:
```bash
docker run -e POSTGRES_PASSWORD= -p 5432:5432 -d postgres
```
This command sets up a PostgreSQL instance with the password choosed, mapping port 5432 on the container to port 5432 on your host machine.
## Configuration
1. **Create a `.env` file in the project root** and add the necessary environment variables:
```env
ADMIN_PASSWORD='12345'
DATABASE_URL='postgres://postgres:12345@localhost:5432/postgres'
JWT_SECRET='your_jwt_secret_key'
PORT=8080
```
2. The environment variables are used as follows:
- **`DATABASE_URL`**: Specifies the connection string for PostgreSQL. It includes the database user, password, host, port, and database name. In this example, it connects to a PostgreSQL instance running locally with the default port.
- **`JWT_SECRET`**: Used for signing and verifying JSON Web Tokens (JWT). Replace `'your_jwt_secret_key'` with a secure key for your application.
- **`ADMIN_PASSWORD`**: Used to create an initial admin user. Ensure this password is secure and properly managed.
- **`PORT`**: The port on which the server will listen for incoming connections.
## Running Locally
To run the project locally, follow these steps:
1. **Install project dependencies** using Cargo:
```bash
cargo build
```
2. **Run the server**:
```bash
cargo run
```
## Endpoints
This project provides the following API endpoints:
| Endpoint | Description | HTTP Method |
| ------------------------- | --------------------------------------------------------- | ----------- |
| `/authenticate` | User authentication endpoint, requires email and password | POST |
| `/status` | Check server status | GET |
| `/users/create_user` | Create a new user (requires authentication) | POST |
| `/users/delete_user/{id}` | Delete a user by id (requires authentication) | DELETE |
| `/users/get_users` | Retrieve a list of all users (requires authentication) | GET |
| `/users/update_user/{id}` | Update a user by id (requires authentication) | PUT |
### JWT Authentication
- **`/authenticate`**: Provides a JWT token upon successful authentication. The token must be included in the `Authorization` header for requests to protected endpoints.
- **Protected Endpoints**: All endpoints except `/status` and `/authenticate` require the user to be authenticated. Ensure that requests to these endpoints include a valid JWT token in the `Authorization` header.
## Images
