2023-11-28

API 설계

항목 : 기능, METHOD, URI, HTTP Status Code
복수형 → 사전에 복수형 단어가 등록되어 있는 경우에만 복수형 사용 나머지는 단수-복수 형태 동일
URI는 /api/v1/ 생략

단어장 관리

기능	METHOD	URI	HTTP 상태 코드
단어장 목록 조회	GET	/vocabulary	200 OK
단어장 등록	POST	/vocabulary	201 Created
단어장 수정	PATCH	/vocabulary	200 OK
단어장 삭제	DELETE	/vocabulary	200 OK

단어장 타입 관리

기능	METHOD	URI	HTTP 상태 코드
단어장 타입 목록 조회	GET	/vocabulary-types	200 OK
단어장 타입 등록	POST	/vocabulary-types	201 Created
단어장 타입 수정	PATCH	/vocabulary-types	200 OK
단어장 타입 삭제	DELETE	/vocabulary-types	200 OK

카테고리 관리

기능	METHOD	URI	HTTP 상태 코드
카테고리 목록 조회	GET	/vocabulary/{id}/categories	200 OK
카테고리 등록	POST	/vocabulary/{id}/categories	201 Created
카테고리 수정	PATCH	/categories	200 OK
카테고리 삭제	DELETE	/categories	200 OK

한자 관리

기능	METHOD	URI	HTTP 상태 코드
한자 목록 조회	GET	/categories/{id}/kanji	200 OK
한자 등록	POST	/categories/{id}/kanji	201 Created
한자 수정	PATCH	/kanji	200 OK
한자 삭제	DELETE	/kanji	200 OK

학습 히스토리 관리

기능	METHOD	URI	HTTP 상태 코드
전체 한자 학습 히스토리 조회	GET	/kanji/learning-history	200 OK
단일 한자 학습 히스토리 조회	GET	/kanji/{id}/learning-history	200 OK
학습 히스토리 등록	POST	/kanji/{id}/learning-history	201 Created

조회와 삭제는 불필요할 것 같아서 제외했습니다.

발음(YOMI) 관리