2023-11-28

API 설계

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

단어장 관리

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

카테고리 관리

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

한자 관리

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

발음(YOMI) 관리

기능	METHOD	URI	HTTP 상태 코드
YOMI 목록 조회	GET	/kanjis/{id}/yomi	200 OK
YOMI 등록	POST	/kanjis/{id}/yomi	200 OK
YOMI 수정	PATCH	/yomi	200 OK
YOMI 삭제	DELETE	/yomi	200 OK

YOMI 타입 관리

기능	METHOD	URI	HTTP 상태 코드
YOMI 타입 목록 조회	GET	/yomi-types	200 OK
YOMI 타입 등록	POST	/yomi-types	200 OK
YOMI 타입 수정	PATCH	/yomi-types	200 OK
YOMI 타입 삭제	DELETE	/yomi-types	200 OK

단어 관리

기능	METHOD	URI	HTTP 상태 코드
단어 목록 조회	GET	/yomi/{id}/words	200 OK
단어 등록	POST	/yomi/{id}/words	200 OK
단어 수정	PATCH	/words	200 OK
단어 삭제	DELETE	/words	200 OK

후리가나 관리