REST API URL 규칙

리소스 명사는 복수형으로


# Good
/language-tests

# Bad
/language-test


# Good
/language-tests
/language-tests/{testId}

# Bad
/language_tests/{test-id}
/languageTests/{test_id}


# Good
POST /language-tests

# Bad
POST /language-tests/create


POST /language-tests/123/revalidate


GET /language-tests

# Response
{
		languageTests: [
			...
		],
		total: 42
}

둘의 역할은 모두 업데이트로 같지만, PATCH는 제공된 필드만 업데이트하고 나머지는 그대로 유지합니다.


GET /posts/2/comments
DELETE /posts/2/comments/3

위와 같이 중첩된 리소스를 표현할 수 있습니다.

이때, 리소스를 nested로 표현할지, flat하게 표현할지 고민이 될 수 있습니다.


# Nested
GET /posts/2/comments/3
# Flat
GET /comments/3

각 방법마다 trade-off가 존재하겠지만, 어떤 방법을 선택할지 고민이 된다면 대부분 flat 한것이 nested보다 낫다는 것을 기억해야합니다.