[웹 API 디자인] 11. 검색을 위한 팁

검색을 위한 팁

간단한 검색은 리소스 기반 API로 모델링될 수 있습니다(예: dogs/?q=red). 하지만 여러 리소스를 대상으로 하는 복잡한 검색은 다른 디자인이 필요합니다.

데이터베이스에서 리소스가 아닌 결과가 반환될 때, 즉 결과가 어떤 작업 또는 계산이어야 하는 경우에는 명사 대신 동사를 사용하는 주제를 읽었다면, 이것은 익숙한 사실일 것입니다.

여러 리소스를 대상으로 하는 전역 검색을 수행하려면, Google 모델을 따르는 것이 좋습니다.

전역 검색

/search?q=fluffy+fur

여기서 search는 동사이고, ?q는 쿼리를 나타냅니다.

범위 지정 검색

검색에 범위를 추가하려면 검색 범위를 앞에 추가할 수 있습니다. 예를 들어, 리소스 ID 5678의 소유자가 소유하는 개에서 검색을 수행하려면 다음과 같이 입력합니다.

/owners/5678/dogs?q=fluffy+fur

URL에서 명시적인 검색을 제거하고 매개변수 ‘q’를 사용하여 범위 지정된 쿼리를 나타내도록 변경한 것에 유의하세요. (이 접근 방식을 세부적으로 다듬는 데 도움을 준 API Craft 구글 그룹의 기여자들에게 큰 감사를 표합니다.)

결과 서식 지정

검색 또는 리소스가 아닌 동작적인 응답의 경우, 다음과 같이 서식을 앞에 추가할 수 있습니다.

/search.xml?q=fluffy+fur