[Chat GPT야] API endpoint(엔드포인트) 네이밍 규칙 가르쳐 줘

다음은 API 엔드포인트 네이밍에 일반적으로 사용되는 가이드라인입니다:

API 엔드포인트 네이밍 규칙은 API 디자인에서 일관성과 명확성을 보장하기 위해 중요합니다.

1. 자원을 나타내기 위해 명사 사용

API 엔드포인트는 자원 또는 자원의 컬렉션을 나타내야 하며,

명사를 사용하여 설명해야 합니다.

예를 들어, 사용자 컬렉션을 나타내기 위해 엔드포인트는 /users로 지정할 수 있습니다.

2. 컬렉션에는 복수 명사 사용

자원의 컬렉션을 나타내는 엔드포인트는 복수 명사를 사용해야 합니다.

예를 들어, 주문 컬렉션을 나타내기 위해 엔드포인트는 /orders로 지정할 수 있습니다.

3. 개별 자원에는 구체적인 이름 사용

개별 자원을 나타내는 엔드포인트는 일반적인 명사보다 구체적인 이름을 사용해야 합니다.

예를 들어, ID가 123인 특정 사용자를 나타내기 위해 엔드포인트는 /users/123로 지정할 수 있습니다.

4. HTTP 동사를 사용하여 작업을 나타냄

자원에 대한 작업을 나타내기 위해 HTTP 동사를 사용해야 합니다.

예를 들어, 새로운 사용자를 생성하기 위해 엔드포인트는 HTTP POST 방법과 함께 /users로 지정할 수 있습니다.

5. 하이픈을 사용하여 단어 구분

하이픈은 엔드포인트 이름에서 단어를 구분하기 위해 사용될 수 있습니다.

예를 들어, /users/123/orders는 /users123orders보다 가독성이 높습니다.

6. 엔드포인트 이름에서 동사 사용 지양

동사를 엔드포인트 이름에 사용하지 마세요.

이는 엔드포인트가 자원인지 작업인지 혼동을 줄 수 있습니다.

대신, 작업을 나타내기 위해 HTTP 동사를 사용하세요.

7. 일관성 유지

API 디자인에서 일관성은 매우 중요합니다.

API 전체에서 동일한 네이밍 규칙을 사용하고,

엔드포인트 간에 쉽게 이해하고 일관성 있게 유지되도록 해야 합니다.

 

이러한 네이밍 규칙을 따르면, 사용자가 쉽게 이해하고 사용할 수 있는 API를 만들어 줄 수 있습니다.