📋 TO-DO LIST
신입 연수원 활동 [o]
2주 1일차 강의 [o]
인턴교육 직후 사수 도움 요청 업무 [o]
팀장님 지시 업무 [o]
중간/일일 업무 보고 작성 [o]
정기 팀/동기 스터디 모임 참석 및 성실도 [o]
📍 학습 내용 정리
RestFul API
REST
REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미합니다.
HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해
해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.
CRUD Operation이란
CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인
Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말
REST에서의 CRUD Operation 동작 예시
Create : 데이터 생성(POST)
Read : 데이터 조회(GET)
Update : 데이터 수정(PUT, PATCH)
Delete : 데이터 삭제(DELETE)
REST API
자원(Resource) : HTTP URI
자원에 대한 행위(Verb) : HTTP Method
자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load
REST API 특징
Server-Client(서버-클라이언트 구조)
Stateless(무상태)
Cacheable(캐시 처리 가능)
Layered System(계층화)
Uniform Interface(인터페이스 일관성)
URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.
good example : /users , /posts
bad example : /getUsers , /Add_Post
- 마지막에 슬래시 (/)를 포함하지 않는다.
good example : /products , /categories
bad example : /products/ , /categories/
- 언더바 대신 하이폰을 사용한다.
good example : /user-profiles , /product-details
bad example : /user_profiles , /product_details
- 파일확장자는 URI에 포함하지 않는다.
good example : /images/profile , /documents/report
bad example : /images/profile.jpg , /documents/report.pdf
- 행위를 포함하지 않는다.
good example : /orders, /payments
bad example : /getOrders , /createPayment
RestFul API
※ RESTFUL이란 REST의 원리를 따르는 시스템을 의미합니다.
하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아닙니다.
REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며
모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은
API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은
REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있습니다.
NoSQL & RDB
RDB(Relational Database)
데이터를 2차원 형태의 테이블로 표현하는 데이터 모델에 기초를 둔 DataBase
엄격하게 정해진 스키마에 따라 데이터를 저장하기에 명확한 데이터 구조를 보장하는 DB
스키마 : DB를 구성하는 데이터 개체, 속성, 관계등 다양한 제약조건을 정의하는 것
중복 데이터가 존재하지 않아서 데이터 수정(update)이 용이하며 테이블이 많아질 경우 JOIN으로 인해 많은 쿼리가 발생하는 단점이 있다
수평적인 확장이 어렵다
RDBMS
관계형 데이터베이스를 생성하고 수정하고 관리할 수 있는 소프트웨어
ex) MySQL / Oracle / Maria-DB 등
NoSQL
Not Only SQL의 약자
기존 RDB의 한계를 극복하고, 수평적인 확장성을 가짐
유연한 스키마를 통해 유연성과 확장성을 가짐
ex) MongoDB / 다이나모 DB
장점
수평적인 확장이 쉽다
데이터의 저장 및 검색을 위한 특화된 매커니즘 제공
--> 응답속도나 처리효율 등에 있어서 매우 뛰어난 성능
| RDB | NoSQL | |
|---|---|---|
| 데이터 저장모델 | Table | json document/key - value/그래프 등 |
| 개발목적 | 데이터 중복감소 | 유연한 데이터 구조 |
| Example | Oracle , MySQL , PostgreSQL | MongoDB , DynamicDB 등 |
| Schema | 엄격한 데이터 구조 | 유연한 데이터 구조 |
| 장점 | 명확한 데이터구조 보장, 데이터 중복 없이 한 번만 저장, 데이터 중복이 없어서 데이터 업데이트 용이 | 유연하고 자유로운 데이터 구조, 새로운 필드 추가 자유로움, 수평적 확장 용이 |
| 단점 | 시스템이 커지면 Join문이 많은 복잡한 query가 필요, 성능 향상을 위해 수직적 확장만 가능하여 비용이 큼, 데이터 구조가 유연하지 못함 | 데이터 중복 발생 가능, 중복 데이터가 많기 때문에 데이터 변경 시 모든 컬렉션에서 수정이 필요함, 명확한 데이터구조 보장 X |
| 사용 | 데이터 구조가 변경될 여지가 없이 명확한 경우, 데이터 업데이트가 잦은 시스템 (중복 데이터가 없으므로 변경에 유리) | 정확한 데이터 구조가 정해지지 않은 경우, 업데이트가 자주 이루어지지 않는 경우 (조회가 많은 경우), 데이터 양이 매우 많은경우 (수평적 확장 가능) |
📍 일일보고
부족한 점 : test를 위해서 Postman을 사용할 때 DB에 존재유무를 생각하지 못하고
데이터가 없어진거라고 착각한 것
스스로 시도해본 것들 :
간단히 메모를 업로드하고 데이터를 조회하는 api작성한적이 있었는데 get요청을 받을때 쿼리값을 같이 받아 조회할 값을 정렬하는 함수를 작성
#정렬하기 위한 함수
def sort_memo_by_property(memos: List[Memo], prop: str, order: str):
if prop == "createdAt":
return sorted(memos, key=lambda x: x.createdAt, reverse=(order == "DESC"))
else:
if order == "ASC":
return sorted(memos, key=lambda x: getattr(x, prop).lower())
else:
return sorted(memos, key=lambda x: getattr(x, prop).lower(), reverse=True)
@app.get("/memos")
def read_memo(sort: str = Query(None, description="정렬 기준 속성"),
order: str = Query("ASC", description="정렬 방법 (ASC 또는 DESC)")):
sorted_memos = memos
if sort == "ABC":
# 가나다ABC순으로 정렬
sorted_memos = sort_memo_by_property(memos, "title", order)
elif sort == "createdAt":
# 등록 순으로 정렬
sorted_memos = sorted(memos, key=lambda x: x.createdAt, reverse=(order == "DESC"))
return [memo.model_dump() for memo in sorted_memos]#가나다순 내림차순
http://localhost:8000/memos?sort=ABC&order=DESC
[
{
"id": 123123,
"title": "나다마",
"content": "이거 아닌가",
"createdAt": "2024-05-06"
},
{
"id": 123123,
"title": "가나다",
"content": "이거 아닌가",
"createdAt": "2024-05-07"
}
]
#가나다순 오름차순
http://localhost:8000/memos?sort=ABC&order=ASC
[
{
"id": 123123,
"title": "가나다",
"content": "이거 아닌가",
"createdAt": "2024-05-07"
},
{
"id": 123123,
"title": "나다마",
"content": "이거 아닌가",
"createdAt": "2024-05-06"
}
]
#등록순 내림차순
http://localhost:8000/memos?sort=createdAt&order=DESC
[
{
"id": 123123,
"title": "가나다",
"content": "이거 아닌가",
"createdAt": "2024-05-07"
},
{
"id": 123123,
"title": "나다마",
"content": "이거 아닌가",
"createdAt": "2024-05-06"
}
]
#등록순 오름차순
http://localhost:8000/memos?sort=createdAt&order=ASC
[
{
"id": 123123,
"title": "나다마",
"content": "이거 아닌가",
"createdAt": "2024-05-06"
},
{
"id": 123123,
"title": "가나다",
"content": "이거 아닌가",
"createdAt": "2024-05-07"
}
]해결 내용 : 에러 구글링 후 파이썬 내부 함수와 변수명이 겹치는 현상 해결
알게된 점 : URI 쿼리에 원하는 파라미터를 받아 정렬하는 코드를 구현하면서
쿼리와 내장함수에 대해 좀 더 깊게 알게 됐다.
헷갈리거나 실수한 점 : 원래 밑에 보이는것처럼 코드를 작성했지만 에러를 맞닥드려서 열심히 구글링...
@app.get("/memos")
#매개변수로 받으려 설정한 sorted의 변수명이 파이썬에 제공하는 내장함수 sorted()와 겹쳐 생기는 오류였다...
#위에 코드에서 sort로 변경 후 정상작동
def read_memos(sorted: str = Query(None, description="정렬 기준 속성"),
order: str = Query("ASC", description="정렬 방법 (ASC 또는 DESC)")):
sorted_memos = memos
if sorted == "ABC":
# 가나다ABC순으로 정렬
sorted_memos = sort_memo_by_property(memos, "title", order)
elif sorted == "createdAt":
# 등록 순으로 정렬
sorted_memos = sorted(memos, key=lambda x: x.createdAt, reverse=(order == "DESC"))
return [memo.model_dump() for memo in sorted_memos]ERROR: Exception in ASGI application
Traceback (most recent call last):
File "/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/uvicorn/protocols/http/h11_impl.py", line 407, in run_asgi
result = await app( # type: ignore[func-returns-value]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/uvicorn/middleware/proxy_headers.py", line 69, in __call__
return await self.app(scope, receive, send)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'str' object is not callable회고 : 1주차를 지나 2주차의 1일차를 들어서서 Python을 사용해 api를 작성하고 구현하는 것을 해보았는데 Postman을 사용해 데이터를 넣어보고 조회하는것이 흥미로웠고 빠르게 프로젝트를 진행하고싶다는 생각이 들었다.
