Rust Simple User Todos

Rust를 사용하여 간단한 Todo-list API를 작성하였습니다.

Skills

• Actix-Web(rust)
• SeaORM(postgresql)
• Docker(docker-compose)

Features

• ORM 사용
  • SeaORM 사용
• JWT Auth
  • Refresh token은 구현하지 않았음
  • token의 만료시간은 15분
  • jwt claims에 user_id를 저장하고 path의 user_id와 비교
    (e.g. jwt's {user_id} == localhost:8080/user/{user_id})
• Bcrypt를 사용한 비밀번호 저장
  • 비밀번호 취급시 bcrypt 저장 및 복호화
• docker-compose 사용
  • rust app, postgresql, 필요시 pgadmin 을 실행
• test code 작성

  • 통합(Integration) 테스트만 작성

  • coverage

    

Schemas

*raw sql schema

API

Option<T>는 nullable 함을 의미합니다.

http://localhost:8080/user/register

• POST
  아래와 같은 데이터를 요구합니다.

  // Content-Type: Application/x-www-form-urlencode
  {
      // 로그인시 식별자로 사용되며
      // 1-20자 사이의 문자열이며 중복은 허용하지 않습니다.
      "username" : String,
  
      // 8-20자
      // 최소 한자 이상의 영대문자
      // 최소 한자 이상의 영소문자
      // 최소 한자 이상의 특수문자($@$!%*?&)
      // 를 포함해야합니다.
      "password" : String, 
  
      // 이메일 형식의 검증을 하지않고 있으며
      // 1-255자 사이의 문자열이며 중복은 허용하지 않습니다.
      "email" : String
  }

  아래와 같은 데이터를 반환합니다.

  // Status Code : 201
  {
      "id" : i32,
      "username" : String,
      "email" : String,
      "created_at" : Datetime
  }

http://localhost:8080/user/login

• POST
  다음과 같은 데이터를 요구합니다

  // Content-Type: Application/x-www-form-urlencode
  {
      "username" : String,
      "password" : String
  }

  다음과 같은 데이터를 반환합니다.

  // Status Code : 200
  {
      "access_token" : String,
      "user" : {
          "id" : i32,
          "username" : String,
          "email" : String,
          "created_at" : Datetime
      }   
  }

http://localhost:8080/user/{user_id}

• PUT
  다음과 같은 데이터를 요구합니다.
  username은 변경 할수 없습니다.
  비밀번호와 이메일만 변경가능하며 반드시 변수 모두 입력해야합니다.

  // Content-Type: Application/x-www-form-urlencode
  {
      "password" : String,
      "email" : String
  }

  다음과 같은 데이터를 반환합니다.

  // Status Code : 200
  {
      "id" : i32,
      "username" : String,
      "email" : String,
      "created_at" : Datetime
  }

• DELETE
  상태코드(status code) 204(No content)를 반환합니다.

http://localhost:8080/user/{user_id}/todo/register

• POST
  다음과 같은 데이터를 요구합니다.

  // Content-Type: Application/json
  {
      // 1-100자 길이 제한
      "name" : String,
  
      // 0-255자 길이 제한
      "contents" : Option<String>,
  
      "due_date" : Option<Date>,
      "completed" : bool
  }

  다음과 같은 데이터를 반환합니다.

  {
      "id" : i32,
      "user_id" : i32,
      "name" : String,
      "contents" : Option<String>,
      "due_date" : Option<Date>,
      "completed" : bool,
      "created_at" : DateTime,
  }

http://localhost:8080/user/{user_id}/todo?page=<u64>

• GET
  필수적으로 쿼리데이터 page=<u64>를 요구합니다.
  다음과 같은 데이터를 반환합니다.

  // id를 기준으로(최신순) 5개씩 반환합니다.
  [
      {
          "id" : i32,
          "user_id" : i32,
          "name" : String,
          "contents" : Option<String>,
          "due_date" : Option<Date>,
          "completed" : bool,
          "created_at" : DateTime,
      },
  ]

http://localhost:8080/user/{user_id}/todo/{todo_id}

• PUT
  다음과 같은 데이터를 요구합니다.

  // Content-Type: Application/json
  {
      "name" : String,
      "contents" : Option<String>,
      "due_date" : Option<Date>,
      "completed" : bool
  }

  다음과 같은 데이터를 반환합니다.

  {
      "id" : i32,
      "user_id" : i32,
      "name" : String,
      "contents" : Option<String>,
      "due_date" : Option<Date>,
      "completed" : bool,
      "created_at" : DateTime,
  }

• DELETE
  상태코드(status code) 204(No content)를 반환합니다.