rocket-rest-api-with-jwt - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #llm #go #golang #machine-learning #linux #docker #macos #java #cli #security #ios

rocket-rest-api-with-jwt

(★ 75)

A Rusty Rocket fuelled with Diesel and secured by JWT

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci_action.yml
  - docker_action.yml
- settings.json
- - Dockerfile
- - Dockerfile
- - libpq.lib
- - down.sql
  - up.sql
- - down.sql
  - up.sql
- - down.sql
  - up.sql
- - down.sql
  - up.sql
- - down.sql
  - up.sql
- .gitkeep
- - account_controller.rs
  - address_book_controller.rs
  - mod.rs
- - message_constants.rs
  - mod.rs
- - login_history.rs
  - mod.rs
  - person.rs
  - response.rs
  - user.rs
- - account_service.rs
  - address_book_service.rs
  - mod.rs
- config.rs
- jwt.rs
- main.rs
- schema.rs
- secret.key.sample
.env.sample
.gitignore
Cargo.lock
Cargo.toml
diesel.toml
docker-compose.local.yml
docker-compose.prod.yml
LICENSE
README.md
Rocket.toml.sample

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/SakaDream/rocket-rest-api-with-jwt

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd rocket-rest-api-with-jwt

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose -f docker-compose.local.yml up -d --build

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. Rust

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

cargo build --release

Rust 프로젝트를 컴파일합니다.

cargo run

빌드 후 바로 실행까지 진행합니다.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rocket REST API with JWT

![CI](https://github.com/SakaDream/rocket-rest-api-with-jwt/workflows/CI/badge.svg)
![Docker CICD](https://github.com/SakaDream/rocket-rest-api-with-jwt/workflows/Docker%20CICD/badge.svg)

A Rusty Rocket 🚀 fuelled with Diesel 🛢 and secured by JWT 🔐

## Require

You can build and run app from source:

- [Rust](https://rustup.rs/)
- [Postgres](https://www.postgresql.org/)

Or using [Docker](https://www.docker.com/)

## How to run

### Manual

- Install Rust nightly (Thanks for Rustup 1.20!): `rustup install nightly`
- Set Rust Nightly to project: Go to the root of the project, open cmd/terminal and run `rustup override set nightly`
- Rename `secret.key.sample` to `secret.key` or create your own key by running `head -c16 /dev/urandom > secret.key` in command line (Linux/UNIX only) and copy to `/src` folder
- Create a database in postgres cli or [pgAdmin](https://www.pgadmin.org/) tool
- Rename `Rocket.toml.sample` to `Rocket.toml` and update the database connection string in `url` key.
- Build with release profile: `cargo build --release`
- Run release binary in command line/terminal. On Windows: `target/release/address_book_rest_api.exe`, on *UNIX: `target/release/address_book_rest_api`
- Enjoy! 😄

### Docker

- Enter into project directory and run `docker-compose up`
- Enjoy! 😄

## APIs

### Address: `localhost:8000`

### `POST /api/auth/signup`: Signup
  - Request body:
  ```
  {
     "username": string,
     "email": string,
     "password": string       // a raw password
  }
  ```
  - Response
    - 200 OK
    ```
    {
       "message": "signup successfully",
       "data": ""
    }
    ```
    - 400 Bad Request
    ```
    {
       "message": "error when signing up, please try again",
       "data": ""
    }
    ```

### `POST /api/auth/login`: Login
  - Request body:
  ```
  {
     "username_or_email": string,
     "password": string       // a raw password
  }
  ```
  - Response
    - 200 OK
    ```
    {
       "message": "login successfully",
       "data": {
         "token": string      // bearer token
       }
    }
    ```
    - 400 Bad Request
    ```
    {
       "message": "wrong username or password, please try again",
       "data": ""
    }
    ```

### `GET /api/address-book`: Get all people information
  - Header:
    - Authorization: bearer \<token\>
  - Response
    - 200 OK
    ```
    {
       "message": "ok",
       "data": [
          {
            "id": int32,
            "name": string,
            "gender": boolean,      // true for male, false for female
            "age": int32,
            "address": string,
            "phone": string,
            "email": string
          }
       ]
    }
    ```

### `GET /api/address-book/{id}`: Get person information by id
  - Param path:
    - id: int32
  - Header:
    - Authorization: bearer \<token\>
  - Response
    - 200 OK
    ```
    {
       "message": "ok",
       "data": {
         "id": int32,
         "name": string,
         "gender": boolean,      // true for male, false for female
         "age": int32,
         "address": string,
         "phone": string,
         "email": string
       }
    }
    ```
    - 404 Not Found
    ```
    {
       "message": "person with id {id} not found",
       "data": ""
    }
    ```

### `GET /api/address-book/{query}`: Search for person information by keyword
  - Param path:
    - query: string
  - Header:
    - Authorization: bearer \<token\>
  - Response
    - 200 OK
    ```
    {
       "message": "ok",
       "data": [
         {
           "id": int32,
           "name": string,
           "gender": boolean,      // true for male, false for female
           "age": int32,
           "address": string,
           "phone": string,
           "email": string
         }
       ]
    }
    ```

### `POST /api/address-book`: Add person information
  - Header:
    - Authorization: bearer \<token\>
  - Request body:
    ```
    {
      "name": string,
      "gender": boolean,      // true for male, false for female
      "age": int32,
      "address": string,
      "phone": string,
      "email": string
    }
    ```
  - Response
    - 201 Created
    ```
    {
      "message": "ok",
      "data": ""
    }
    ```
    - 500 Internal Server Error
    ```
    {
      "message": "can not insert data",
      "data": ""
    }
    ```

### `PUT /api/address-book/{id}`: Update person information by id
  - Param path:
    - id: int32
  - Header:
    - Authorization: bearer \<token\>
  - Request body:
  ```
  {
    "name": string,
    "gender": boolean,      // true for male, false for female
    "age": int32,
    "address": string,
    "phone": string,
    "email": string
  }
  ```
  - Response
    - 200 OK
    ```
    {
      "message": "ok",
      "data": ""
    }
    ```
    - 500 Internal Server Error
    ```
    {
      "message": "can not update data",
      "data": ""
    }
    ```

### `DELETE /api/address-book/{id}`: Delete person information by id
  - Param path:
    - id: int32
  - Header:
    - Authorization: bearer \<token\>
  - Response
    - 200 OK
    ```
    {
      "message": "ok",
      "data": ""
    }
    ```
    - 500 Internal Server Error
    ```
    {
      "message": "can not delete data",
      "data": ""
    }
    ```

### Errors:
  - Invalid or missing token
    - Status code: 401 Unauthorized
    - Response:
    ```
    {
      "message": "invalid token, please login again",
      "data": ""
    }
    ```