🦁 Python Online Store 만들기 5편 - 판매상품 등록 API

🎈 Front End Developer 의 Back End 도전기 ! 🎈

이 글은 PROJECT LION : 호코치 강사님의 강의를 들으며 참고한 글입니다.

작업 중, 개발과정 정리 및 issue가 되었던 부분들을 공유 및 기록하고자 작성하게 되었습니다.

1. CRUD란?

✍ data 저장 및 보여지는 것(저장/보여주기/수정/삭제) -> 즉, OnlineStore 를 구현하기 위해서는 4가지가 필요하다.

저장한 상품 정보를 보여줌으로써, 상품 list page를 구성할 수 있다.

Create -> database에 Product Collection 생성 및 상품정보 저장
Read -> Product Collection 에 저장한 data를 꺼내서 보여줌
Update -> Product Collection 에서 수정하고 싶은 상품의 가격 정보 수정
Delete -> Product Collection 에 저장한 document 중, 삭제를 원하는 상품을 삭제

2. 상품등록을 위한 API 구현

✍ 상품정보를 저장할 때, 필요정보들(상품 고유번호, 상품명, 가격, 설명 등) 정보들을 MongoDB 에 저장할 것이다.

즉, Product라는 Collection에 document 로 상품 정보를 하나하나 저장할 것이다.

document -> 상품 고유번호, 상품명, 가격, 설명 등 정보들이 각각 key-value 형태로 저장될 것이다.

id : 101
name: 신발
price: 10000
description: 하얀 신발입니다.

작업 전 흘러가는 로직을 생각해보자면,
1. 상품 등록을 하기위한 form 및 내부 input 들(정보 기입란) 이 필요할 것이고,
2. 상품저장 버튼을 클릭 시 상품등록이 되어야 한다.

-> post 방식([POST]/product/regist) 주소로 상품등록 API를 구현해 놓았다면, 상품등록 버튼을 누를때 post 방식 주소로 필요한 data와 함께 요청을 보내면 flask에서 상품을 등록, 저장 후 응답을 보내줄 것이다.

머리 속의 구상을 그대로 내뱉으니 설명이 장황한 거 같다.. 😂

그렇다면 그림을 그려보자(?)

1. input에 data값 입력
2. 등록버튼 click
3. 상품등록 api로 구현해둔 post방식 주소로 필요한 data 요청(전송)
4. 상품 등록 및 저장 (db)
5. 응답 (저장완료 또는 실패했다면 실패)

이런 로직으로 흘러간다고 생각하면 되겠다!!!

3. 코드 작성 및 구현

1. 작업 전 local port 에서 확인해야 하므로, terminal 실행 및 flask run

2. local port 작동 확인
   = app_route("/") 뒤 어떤 값이 붙느냐에 따라 API 요청을 받게 된다.
   뒤에 /home 이라는 값이 붙게 된다면, home이 root 경로가 되는 것이다.
   즉, localport/home -> Hello, World! 가 출력이 된다.
   

3. 결과 화면을 확인할 때, 또는 다른 작업 후 계속해서 화면을 확인 할 때 flask run을 반복해서 실행해 주어야 하므로, 해당 코드 및 py-3 app.py 실행
   -> (상단 img 14~15번 줄)

   정상적으로 실행이 되어야 하는 상황인데 오류가 발생했다. 😐

   flask가 설치되어 있지 않아 찾을 수 없다는 것 같았다.
   지난 3편 에서도 pymongo 를 찾을 수 없어 재설치 해주었는데, 똑같은 경우인 것 같아 설치해주니 정상적으로 실행되었다..😒

   아마, requirements.txt 에서 package 들이 정상적으로 설치되어 있지 않은 것 같았다. (일일이 pip install을 다 시켜주었다 ㅠㅠ)

4. 상품 등록 API 작성
   4-1. controllers folder 생성
   4-2. controllers > product.py 생성
   = 상품과 관련된 API 들을 정의해 놓을 파일(상품 등록, 추가, 삭제 등등)
   4-3. controllers > blueprint.py 생성
   = 상품 및 사용자와 관련된 API 들을 정의할텐데

   ex)
   [상품]
   /products/regist
   /products/list
   ...
   [사용자]
   /users/signup
   /users/signin

   / 결제
   / 주문 등등..

   이런 api들을 각각 구분 및 나누어 두기 위해 blueprint 파일 사용

   원래 app.py에서는 /값으로 접속 시 return 값 ("Hello, World") 가 반환되었는데 -> blueprint 사용 및 register_blueprint 등록 후 controllers > product 의 API 들은 products 로 주소가 시작된다.

   

   말로 표현하기보단 역시 그림이 짱이다 ^__^

5. 상품 등록 API 필요 부분 작성
   = 상품등록 regist에서 필요한 부분은 전달받은 상품 정보 , 저장하는 일 2가지로 구성할 수 있다.

• models/product.py 생성 전
  
• models/product.py 생성 후
  

= 생성 전과 생성 후에 대한 설명은 6번에 !!

6. models/product.py 생성
   

   = 사실 models 내부의 product.py 파일은 생성하지 않아도 상관이 없다.
   하지만, form_data의 값과 insert_one의 값을 보기 좋게 효율적으로 바꿀 수 있겠다는 생각이 들어 나름대로 정리를 해보았다.

   1. 우선, 저장하는 code를 models > product.py 파일에 생성한다.
   2. mongodb include
   3. product 에 대한 정보 받음
   4. controllers > product 의 정보들을 models > product 로 넘겨준다. (각각의 정보를 꺼내서 넣어주던걸 form_data로 한번에 넘겨줄 수 있게 되었다.)

7. API 테스트

   1. Insomnia program 설치
   2. Create -> Request Collection
   3. products
   4. New request -> regist/방식은 Post/ 구조는 multipart-form
   5. 주소 작성 (http://127.0.0.1:5000 포트)
      http:://127.0.0.1
   6. name/price/description 상품정보 전달
      

   🎲 Insomnia 화면

   7. MongoDB Compass 접속
      = online_store DB에 지난시간 test를 위해 만든 test_connection 만 있을테지만, products collection이 생성되어 있을 것이다.
      click 시 전송시킨 documents 도 생성되어 있을 것이다.
      

   🎲 MongoDB 화면

상품 등록에 관한 내용은 마무리되었다!

계획은 8월 막바지 개강 전에 온라인 스토어를 마무리 시키려 하였는데, 좋은 기회가 생겨 3째주부터 업무 외의 새로운 개인 프로젝트를 시작하게 되었다.

속도를 내어 온라인 스토어부터 빨리😂 끝내도록 해야겠다 !

다음 시간에는 상품 이미지 업로드 기능을 구현해 보도록 하겠다. 😎