REST API URL에서 여러 매개변수를 전달하는 방법

REST API URL 는 웹 서비스의 중요한 구성 요소입니다. 그것이 없다면 웹사이트가 컬렉션 내에서 리소스를 찾기가 어려울 것입니다. 본질적으로, 그것들은 웹사이트가 사용자들의 의도에 따라 디스플레이를 변경할 수 있게 해줍니다.

REST API URL에서 여러 매개변수를 전달하는 방법을 확실히 이해하려면, 먼저 이 질문의 전제를 이해해야 합니다.

매개변수란 무엇인가요?

매개변수는 URL에 삽입된 정보의 조각으로, 요청된 리소스나 작업과 관련된 추가 세부정보를 제공합니다. 그것은 또한 웹 페이지에 대한 추가 필터 계층으로 간주될 수 있습니다.

매개변수는 어디에 사용되나요?

REST API URL에서 매개변수가 전달되는 많은 실제 상황이 있습니다. 매개변수를 쉽게 찾아볼 수 있는 주요 시나리오는 다음과 같습니다:

• REST API:매개변수는 리소스 변형을 지정, 데이터를 필터링하거나 작업을 제어합니다.
• 검색 엔진:매개변수는 검색 쿼리를 세분화하거나 추천을 추적하는 데 사용됩니다.
• 전자상거래 사이트:제품 필터링, 쇼핑 카트 관리 또는 캠페인 추적을 위해.
• 소셜 미디어 플랫폼:콘텐츠를 개인화하거나 특정 작업을 트리거하기 위해.

REST API URL에서 매개변수를 전달하는 일반 매개변수 유형

일반적으로 REST API URL에서 전달할 수 있는 두 가지 유형의 매개변수가 있습니다.

쿼리 매개변수

쿼리 매개변수는 물음표 ( ? ) 뒤에 추가되는 매개변수 유형입니다. 일반적으로 쿼리 매개변수는 등호 ( = )로 구분된 키-값 쌍으로 제공되며, 각 키-값 쌍은 앰퍼샌드 ( & )로 연결됩니다.

쿼리 매개변수가 전달되는 REST API URL의 예시는 다음과 같습니다:

https://api.example.com/users?id=123&name=John%20Appleseed

우리가 볼 수 있는 키-값 매개변수 쌍은:

• id의 값은 123입니다.
• name의 값은 John Appleseed입니다.

경로 매개변수

경로 매개변수는 REST API URL에서 일반적으로 전달되는 또 다른 유형의 URL 매개변수입니다. 이 매개변수는 해당 시스템 내의 특정 리소스를 식별하고 접근하는 데 사용됩니다.

경로 매개변수의 모양과 구조는 쿼리 매개변수와 다르며, 그 기능도 약간 다릅니다. 경로 매개변수는 컬렉션 내에서 특정 리소스를 고유하게 식별하는 데 더 많이 사용됩니다.

경로 매개변수의 예시는 다음과 같습니다:

플레이스홀더가 있는 경우: https://api.example.com/blog/posts/{post_id}

플레이스홀더가 없는 경우: https://api.example.com/blog/posts/123

우리가 관찰할 수 있듯이, 경로 매개변수는 플레이스홀더 구조(이 예에서 {post_id})를 사용하여 실제 값으로 대체됩니다.

여러 경로 매개변수를 결합하여 시스템 내에서 더 구체적인 리소스를 식별할 수 있습니다. REST API URL에서 매개변수를 전달하는 더 복잡한 예시는 다음과 같습니다:

https://api.example.com/users/{user_id}/posts/{post_id}

URL에서 발견된 플레이스홀더에 대한 실제 값이 있으면 웹사이트의 디스플레이를 변경할 수 있습니다. 경로 매개변수를 사용하면 더 읽기 쉬운 REST API URL을 생성할 수도 있습니다.

REST API URL에서 매개변수를 전달하기 위한 단계

REST API URL이 어떤 용도로 사용되는지, 또는 REST API URL을 어떻게 만들고 싶은지 고민해 보세요. 다양한 웹사이트는 다양한 요구를 가지고 있으므로, 하나의 매개변수가 다른 매개변수보다 더 선호할 수 있습니다.

보다 동적인 웹사이트를 구축할 계획이거나 매개변수가 대부분 선택 사항인 경우, 쿼리 매개변수 사용을 고려할 수 있습니다.

그러나 특정 리소스에 액세스하기 위해 매개변수를 자주 다루어야 하는 경우 경로 매개변수를 선택해야 합니다.

또한 REST API URL을 만드는 모범 사례를 숙지하는 것이 좋습니다. 잘 모르는 또는 듣지 못한 몇 가지 포인터가 있을 수 있습니다.

Apidog - REST API 개발 플랫폼

Apidog 는 우아하고 깨끗한 UI를 갖춘 디자인 우선 API 개발 플랫폼입니다. 그 직관적이고 명확한 인터페이스는 필요한 곳에서 쉽게 탐색하고 API를 수정할 수 있게 해줍니다.

Apidog는 REST API를 가져오고, REST API URL을 수정하고, URL을 테스트할 수 있는 기능도 가지고 있습니다. REST API를 수정하기 위해 Apidog를 운영하는 방법을 배우려면 아래 섹션을 계속 읽으세요.

Apidog를 사용하여 REST API URL, 메서드 및 엔드포인트 구성하기

Apidog를 사용하여 자신만의 API를 만들 수 있으며, REST API URL에 여러 매개변수를 전달하는 방법을 실습할 수 있습니다!

화살표 1 - 요청을 위한 REST API URL을 작성하는 것으로 시작합니다. 오타가 없도록 확인하여 응답을 받을 수 있도록 하세요! 포함하고자 하는 매개변수의 수와 종류를 결정할 수 있습니다.

화살표 2 - 원하는 REST API 메서드를 결정합니다. 일반적인 메서드는 GET, POST, PUT 및 DELETE입니다. 그러나 각 메서드는 URL 내에서 매개변수 및 ID가 필요할 수 있습니다.

화살표 3 - 요청 매개변수, 응답 매개변수 및 예제 응답을 포함하여 REST API 세부정보를 철저히 설명합니다. 모든 변수를 API 문서에 포함하기 위해 모든 항목을 채우는 것이 강력히 권장됩니다.

Apidog로 API 엔드포인트(또는 API URL) 테스트하기

REST API를 생성한 후, 생성한 REST API URL이 성공적인지 여부를 테스트할 수 있습니다. 아래 이미지와 유사한 화면을 볼 수 있어야 합니다:

Apidog는 SOAP 및 GraphQL API를 포함한 대부분의 API 엔드포인트 테스트를 지원합니다. (위 그림에서 보이는 API는 SOAP API입니다.)

먼저 화면 오른쪽에 있는 REST API 요청을 선택합니다(화살표 1 참조).

그런 다음 화살표 2로 표시된 버튼을 클릭하여 요청을 보낼 수 있지만, 올바른 환경을 선택했는지 또는 올바른 요청 API URL을 포함했는지 확인하세요.

마지막으로 응답 섹션으로 이동하여 요청을 보낸 후 수신된 응답을 확인하고, 예상한 것과 동일한지 확인하세요.

결론

REST API URL에서 여러 매개변수를 전달하는 것은 웹 개발 프로세스의 일반적인 부분이 될 것입니다. 웹사이트와 데이터베이스가 성장함에 따라 REST API URL의 길이와 복잡성도 증가할 것이므로, 이러한 개념에 익숙해지는 것은 결코 빠르지 않습니다.

여러 매개변수로 REST API URL을 만드는 연습을 할 API 개발 플랫폼이 필요하다면, 항상 Apidog를 사용하는 것을 고려해볼 수 있습니다. Apidog는 전체 API 생애 주기를 위한 다양한 수정 및 사양도 제공하므로, 지금 바로 시도해 보세요!