API 엔드포인트 이름을 지정하는 7가지 모범 사례

API 끝점은 두 소프트웨어 프로그램 간의 연결 지점입니다. API에는 각 리소스에 대한 엔드포인트가 있습니다. 끝점은 서버에서 리소스의 정확한 위치를 지정합니다.

클라이언트 응용 프로그램이 서버에서 정보를 요청하면 API를 통과합니다. 그런 다음 요청에 액세스하고 서버의 응답을 처리합니다. 그런 다음 API는 엔드포인트에서 애플리케이션으로 요청된 정보를 전송합니다.

끝점을 통해 효과적으로 통신할 수 있으면 API가 효율적입니다. 사용자가 리소스에 쉽게 액세스할 수 있도록 하여 사용자 경험을 향상시킵니다.

API 엔드포인트는 어떻게 작동합니까?

통합 시스템은 API를 통해 통신합니다. 한 시스템은 SOAP 또는 REST와 같은 형식을 사용하여 API에 요청을 보냅니다. 서버는 요청을 수신하고 응답을 다시 API로 전송합니다. 요청된 리소스의 위치는 엔드포인트입니다.

엔드포인트가 요청을 처리하기 전에 클라이언트는 URL, 헤더 및 본문을 제공해야 합니다. 헤더에는 요청에 대한 메타데이터와 서버로 전송되는 본문 세부 정보 데이터가 포함됩니다. 서버는 API 메서드가 액세스할 수 있는 데이터베이스에 연결할 수도 있습니다.

API 끝점은 일반적으로 GET, DELETE, PATCH 또는 POST와 같은 HTTP 메서드와 함께 작동합니다. 메서드는 끝점을 사용하는 방법을 결정합니다. 클라이언트가 요청을 보낼 때 요청 메서드와 URL을 포함하도록 공식화해야 합니다. 예를 들면 다음과 같습니다.

GET https://example.com/books/authors

API 엔드포인트, 네트워크로 연결된 하드웨어 장치, 함수 및 변수 등 이름 지정은 어렵습니다. API 엔드포인트가 자산인지 확인하기 위해 사용할 수 있는 몇 가지 모범 사례에 대해 알아야 합니다.

1. 슬래시 사용

항상 슬래시를 사용하여 URI 리소스를 구분합니다. 슬래시는 리소스 계층 구조를 표시하는 데도 도움이 됩니다. 다음은 예입니다.

2. 동사가 아닌 명사 사용

리소스 이름을 지정할 때는 명사만 사용해야 합니다. 리소스가 수행하는 작업을 설명하는 동사와 달리 명사는 리소스의 용도를 설명합니다. 다음은 API 끝점의 이름을 지정하는 좋은 방법과 나쁜 방법의 예입니다.

좋은 이름:

잘못된 이름 지정:

http://example.com/api/books

3. 단수가 아닌 복수 명사 사용

항상 복수 명사로 API 끝점의 이름을 지정해야 합니다. 이는 서버에 둘 이상의 리소스가 있음을 사용자에게 나타냅니다. 단수 명사를 사용하면 사용자가 리소스가 하나만 있다고 생각하도록 혼동할 수 있습니다.

좋은 이름:

잘못된 이름 지정:

http://example.com/api/books/3

4. 소문자 사용

모든 URL은 소문자로 입력해야 합니다. 여기에는 API 끝점 URL이 포함됩니다. 다음은 예입니다.

좋은 이름:

http://example.com/api/Books/3

잘못된 이름 지정:

http://example.com/api/books/3

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

결합된 단어를 구분하려면 하이픈을 사용하십시오. 하이픈은 카멜 케이스나 밑줄보다 더 읽기 쉬운 구문이 됩니다. 그들은 또한 SEO 목적에 더 좋습니다.

좋은 이름:

잘못된 이름 지정:

6. 파일 확장자를 추가하지 마십시오

API 엔드포인트에 파일 확장자를 추가할 필요가 없습니다. 출력에 영향을 미치지는 않지만 확장은 리소스를 읽기 어렵게 만듭니다. 또한 리소스의 유연성을 떨어뜨리고 나중에 확장이 변경되면 중단됩니다.

좋은 이름:

잘못된 이름 지정:

7. 버전 관리 포함

항상 버전에 따라 API 끝점의 이름을 지정해야 합니다. 이는 API를 크게 변경하는 경우에 중요합니다. 리소스가 제공되는 둘 이상의 API 버전을 구별하는 데 도움이 됩니다. 엔드포인트 시작 부분에 버전을 표시할 수 있습니다.

예를 들어:

API 모범 사례를 고려하는 이유는 무엇입니까?

API는 현대 프로그래밍의 근간이 되었습니다. 협업을 개선하고 혁신을 장려하며 애플리케이션 보안을 개선합니다.

새로운 도구를 사용하든 기존 도구를 관리하든 관계없이 API는 프로세스를 단순화합니다. 따라서 사용자 경험을 개선하는 엔드포인트가 있어야 합니다. API 엔드포인트의 이름 지정 및 구조는 API의 성능을 결정합니다.

모범 사례를 사용하여 효율적인 API 끝점을 만드십시오.