bky373 / comma-board

먼저

• 웹 백엔드 과제 내용에 해당하는 API 구현을 모두 마쳤습니다.
• // TODO 주석에 수정사항들을 기록하고 중간중간 코드 수정이 있지만 부족한 부분이 보이면 언제든지 코드리뷰 부탁드립니다ㅎㅎ :)
• csrf token을 사용하면서 포스트맨을 활용하기가 어려워졌습니다(제 기준입니다)
  • csrf token을 사용하면서 포스트맨을 어떻게 활용해야하는지 방법을 알려주시면 감사하겠습니다

❛ Comma ❜ Board 소개

• ❛ Comma ❜는 💻Computer Engineering/Science와 📐Mathematics의 합성어로, 컴퓨터 관련 지식과 수학을 공부하는 사람들이 (전공자가 아니더라도) 쉬어가면서 (,) 서로 정보를 공유할 수 있도록 만든 게시판입니다.
• 앞으로 어떻게 구현해나갈지는 아직 막막하지만.. 공부해가면서 부족한 부분들을 채워볼(?) 예정입니다.

---

개발 환경 준비

1. 가상 환경 준비 (참고)

• 터미널에서 comma_board 디렉토리로 이동한다 ( git clone 또는 download 이후)

• // 터미널에서 아래 명령어를 수행한다
  
  python -m venv venv  // 가상 환경 생성
  source [각자의 경로/comma_board]/venv/Scripts/activate  // 가상 환경 활성화
  (또는 cd [각자의 경로/comma_board]/venv/Scripts 입력 후 activate 입력)
  pip install -r requirements.txt  // 필요한 패키지 설치

2. 데이터베이스 접속 준비

• DB에 접속하기 위해 설정파일(config.py)의 DB_URL 정보를 자신의 DB 정보로 대체한다

• // comma_board/config.py
  // user, pw, host, port, db 모두 자신의 DB 정보로 대체한다 
  
  DB_URL = 'mysql+pymysql://{user}:{pw}@{host}:{port}/{db}?charset=utf8'.format(
      user = mysecrets.dbuser,
      pw = mysecrets.dbpass,
      host = mysecrets.dbhost,
      port = mysecrets.dbport,
      db = mysecrets.dbname # 아래 내용 참고 
  )
  
  """
  추후 문제 없이 SQLAlchemy를 사용하려면 
  접속하려는 MySQL 서버에, 해당 이름의 db가 있어야 한다
  db가 없다면, 터미널 또는 Workbench를 통해 db를 생성해준다
  (db 접속 및 생성 과정은 이곳을 참조한다
   -> https://dev.mysql.com/doc/refman/8.0/en/connecting-disconnecting.html)
  """

3. 데이터베이스 초기화

• flask db init  // 데이터베이스를 관리하는 초기 파일들이 담긴 migrations 디렉토리 생성
  flask db migrate  // 데이터베이스 모델 테이블 생성 및 변경(사실은 revision 파일이 생성됨)
  flask db upgrade  // 데이터베이스 갱신(위에서 생성된 revision 파일이 실행됨)

4. 애플리케이션 설정 후 실행하기

• // 다시 터미널에서, [comma_board] 라는 이름의 최상위 패키지로 이동한 후
  // 아래 명령어를 수행한다
  
  set FLASK_APP=comma_board  // FLASK_APP 환경 변수에 comma_board를 지정
  flask run  // 앱 실행하기

API 소개

User APIs:

• 유저 SignUp / Login / Logout

1. SignUp API : fullname, email, password 을 입력받아 새로운 유저를 가입시킵니다.

   $ curl http://localhost:5000/auth/signup -H "Content-Type: application/json" -d "{""fullname"":""test"", ""email"":""[e-mail]"", ""password"":""test""}" -X POST
   {
     "result": {
       "date_joined": "Fri, 12 Feb 2021 13:44:42 GMT",
       "email": "[e-mail]",
       "fullname": "test",
       "id": 4
     },
     "status": "success"
   }

2. Login API : email, password 를 입력받아 특정 유저로 로그인합니다.

   $ curl http://localhost:5000/auth/login -H "Content-Type: application/json" -d "{""email"":""[e-mail]"",
    ""password"":""test""}" -X POST
   {
     "result": {
       "date_joined": "Fri, 12 Feb 2021 13:44:42 GMT",
       "email": "[e-mail]",
       "fullname": "test",
       "id": 4
     },
     "status": "success"
   }

3. Logout API : 현재 로그인 된 유저를 로그아웃합니다.

   $ http://localhost:5000/auth/logout
   {
     "msg": "logout success",
     "status": "success"
   }

Board APIs:

• 게시판 CRUD

1. Create API : name 을 입력받아 새로운 게시판을 만듭니다.

   $ curl http://localhost:5000/boards -d name=board1 -d user_id=1 -X POST
   {
     "result": {
       "date_created": "Fri, 12 Feb 2021 13:17:19 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:17:19 GMT", // 수정 기능 추후 보완 예정..
       "id": 6,
       "name": "board1",
       "user_id": 1
     },
     "status": 200
   }
   
   

2. Read API : 현재 등록된 게시판 목록을 가져옵니다.

   $ curl http://localhost:5000/boards
   {
     "result": [
       {
         "date_created": "Fri, 12 Feb 2021 13:17:19 GMT",
         "date_modified": "Fri, 12 Feb 2021 13:17:19 GMT",
         "id": 6,
         "name": "board1",
         "user_id": 1
       }
     ],
     "status": 200
   }
   

3. Update API : 기존 게시판의 name 을 변경합니다.

   $ curl http://localhost:5000/boards -d name=board2 -d id=6 -X PUT
   {
     "result": {
       "date_created": "Fri, 12 Feb 2021 13:17:19 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:17:19 GMT", // 수정 기능 추후 보완 예정..
       "id": 6,
       "name": "board2", // board1에서 board2로 변경
       "user_id": 1
     },
     "status": 200
   }

4. Delete API : 특정 게시판을 제거합니다.

   $ curl http://localhost:5000/boards -d id=6 -X DELETE
   {
     "result": {
       "date_created": "Fri, 12 Feb 2021 13:17:19 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:17:19 GMT",
       "id": 6,
       "name": "board2",
       "user_id": 1
     },
     "status": 200
   }
   
   $ curl http://localhost:5000/boards
   {
     "result": [],
     "status": 200
   }

BoardArticle APIs:

• 게시판 글 CRUD

1. Create API : title, content 를 입력받아 특정 게시판에 새로운 글을 작성합니다.

   $ curl http://localhost:5000/boards/7 -d title=title1 -d content=content1 -d user_id=1 -X POST
   {
     "result": {
       "board_id": 7,
       "content": "content1",
       "date_created": "Fri, 12 Feb 2021 13:29:13 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:29:13 GMT",
       "id": 17,
       "title": "title1",
       "user_id": 1
     },
     "status": 200
   }

2. Read API : 게시판의 글 목록을 가져오거나, 특정 게시판 글의 내용을 가져옵니다.

   $ curl http://localhost:5000/boards/7  => 나중에 Board API로 옮기기
   {
     "result": [
       {
         "board_id": 7,
         "content": "content1",
         "date_created": "Fri, 12 Feb 2021 13:29:13 GMT",
         "date_modified": "Fri, 12 Feb 2021 13:29:13 GMT",
         "id": 17,
         "title": "title1",
         "user_id": 1
       },
       {
         "board_id": 7,
         "content": "content1",
         "date_created": "Fri, 12 Feb 2021 13:30:02 GMT",
         "date_modified": "Fri, 12 Feb 2021 13:30:02 GMT",
         "id": 18,
         "title": "title1",
         "user_id": 1
       }
     ],
     "status": 200
   }
   
   
   $ curl http://localhost:5000/boards/7/17
   {
     "result": {
       "board_id": 7,
       "content": "content1",
       "date_created": "Fri, 12 Feb 2021 13:29:13 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:29:13 GMT",
       "id": 17,
       "title": "title1",
       "user_id": 1
     },
     "status": 200
   }

3. Update API : 게시판 글의 title, content를 변경합니다.

   $ curl http://localhost:5000/boards/7/17 -d title="updated title1" -d content="updated content1" -d user_id=1
    -X PUT
   {
     "result": {
       "board_id": null,
       "content": "updated content1",
       "date_created": "Fri, 12 Feb 2021 13:29:13 GMT",
       "date_modified": "Fri, 12 Feb 2021 13:29:13 GMT",
       "id": 17,
       "title": "updated title1",
       "user_id": 1
     },
     "status": 200
   }

4. Delete API : 특정 게시판 글을 제거합니다.

   $ curl http://localhost:5000/boards/7/18 -X DELETE
   {
     "result": {
       "deleted": {
         "board_id": 7,
         "content": "content1",
         "date_created": "Fri, 12 Feb 2021 13:30:02 GMT",
         "date_modified": "Fri, 12 Feb 2021 13:30:02 GMT",
         "id": 18,
         "title": "title1",
         "user_id": 1
       }
     },
     "status": 200
   }

Dashboard APIs

1. RecentBoardArticle API : 모든 게시판에 대해 각각의 게시판의 가장 최근 n 개의 게시판 글의 title 을 가져옵니다. (k 개의 게시판이 있다면 최대 k * n 개의 게시판 글의 title 을 반환합니다.)

   $ curl http://localhost:5000/dashboard/2
   {
     "result": [
       {
         "board_id": 7,
         "board_name": "board1",
         "titles": [
           {
             "date_created": "Fri, 12 Feb 2021 13:30:05 GMT",
             "title": "title1"
           },
           {
             "date_created": "Fri, 12 Feb 2021 13:30:04 GMT",
             "title": "title1"
           }
         ]
       },
       {
         "board_id": 8,
         "board_name": "board2",
         "titles": [
           {
             "date_created": "Fri, 12 Feb 2021 13:30:21 GMT",
             "title": "title2"
           },
           {
             "date_created": "Fri, 12 Feb 2021 13:30:20 GMT",
             "title": "title2"
           }
         ]
       },
       {
         "board_id": 9,
         "board_name": "board3",
         "titles": [
           {
             "date_created": "Fri, 12 Feb 2021 13:30:37 GMT",
             "title": "title3"
           },
           {
             "date_created": "Fri, 12 Feb 2021 13:30:35 GMT",
             "title": "title3"
           }
         ]
       }
     ],
     "status": "success"
   }

---

참고 자료

• Elice 수업 자료
• Flask Tutorial
• Jump To Flask
• Flask Restful Docs
• SQLAlchemy 모델 serialize하는 간단한 방법
• API 에러를 JSON으로 반환하는 방법
• Flask-SQLAlchemy 사용시 json으로 데이터 가공하기 (이 프로젝트에서는 사용 안 함)
• SQLAlchemy Query를 Pandas DataFrame로 만들기 (이 프로젝트에서는 사용 안 함)