[Next.js] 공개 API 호스트, 공개 API URL

nextjs 프로젝트를 하다가 서버가 바뀌어 .env 파일을 수정하던 중에 궁금증이 생겨 찾아봄

 

 

NEXT_PUBLIC_API_URL=https://api.example.com //클라이언트 사이드에서 접근 가능한 공개 API URL
SECRET_API_KEY=your-secret-key //서버 사이드에서만 접근 가능한 비밀 API 키

NEXT_PUBLIC_API_HOST=http://13.124.7.84:8080 //클라이언트 사이드에서 접근 가능한 공개 API 호스트
NEXT_PUBLIC_API_HOST_OLD=http://13.124.7.84:8080 //이전, 또는 대체 API 호스트

 

 

공개 API URL과 공개 API 호스트의 차이가 무엇인지 궁금해 찾아봤다.

요것들은 서로 관련은 있지만 조금은 다른 개념이라고 한다.

 

공개 API 호스트 (Public API Host)

- 정의: API 호스트는 API 서버가 위치한 도메인 또는 IP 주소를 말함.

- 형식: 일반적으로 호스트는 http:// 또는 https:// 로 시작하며, 도메인 이름 또는 IP 주소를 포함한다.

           예를 들면, http://13.124.7.84:8080 이나 https://api.example.com 과 같은 형식임.

- 역할: 공개 API 호스트는 클라이언트가 API 요청을 보낼 때 참조할 서버 위치를 제공함. 주로 Next.js와 같은 프레임 워크에서

           클라이언트 측의 API 요청을 보낼 때 이 호스트를 기반으로 URL을 조합하게 된다.

 

 

공개 API URL (Public API URL)

- 정의: API URL은 API 요청을 위한 전체 경로를 말함. 여기에는 호스트 외에도 API의 특정 엔드 포인트를 포함한다.

- 형식: https://api.example.com/users 또는 http://13.124.7.84:8080/api/v1/resource 와 같이 호스트와 경로가 결합된 형태.

- 역할: 공개 API URL은 API서버의 특정 리소스나 엔드포인트에 대한 요청을 보낼때 사용됨. 단순히 서버의 위치를 가르키는

           호스트와 달리, API의 기능을 사용하는데 필요한 정확한 주소를 제공함

 

 

 

 

 

 

차이점 요약

 

• 구성 요소:
  • 호스트: API 서버의 위치를 나타내는 기본 도메인 또는 IP 주소.
  • URL: 호스트 + 경로, API의 특정 기능에 접근하기 위한 전체 경로.
• 사용 시점:
  • 호스트: 클라이언트가 어디로 요청을 보내야 하는지를 결정할 때.
  • URL: 클라이언트가 API의 특정 기능을 호출할 때.
• 유연성:
  • 호스트: 일반적으로 변경이 적고, API 서버의 위치가 바뀔 때만 업데이트됨
  • URL: 엔드포인트마다 다를 수 있으며, API 기능이 추가되거나 변경될 때마다 업데이트됨

 

결론적으로, 호스트는 API 서버의 기본 위치를 가르키고, URL은 특정 API 기능에 대한 전체 경로를 제공함.

API를 사용할 때 이 두 개념을 잘 사용해서 클라이언트가 원하는 리소스에 올바르게 접근하도록 하자