API에서의 JSONPath: 간단한 가이드

거대한 JSON 응답을 검색하면서 필요한 데이터 한 조각을 찾으려고 애쓴 적이 있나요? 그랬다면 건초 더미에서 바늘을 찾는 것과 같다는 것을 알고 있을 것입니다. JSONPath를 소개합니다 - API에서 JSON 데이터를 처리할 때 당신의 삶을 훨씬 더 쉽게 만들어 줄 유용한 도구입니다.

JSONPath란 무엇인가요?

JSONPath는 XML의 XPath와 유사한 JSON 쿼리 언어입니다. 이는 간단하고 직관적인 구문을 사용하여 JSON 데이터 내에서 특정 부분을 탐색하고 추출할 수 있게 해줍니다. 이를 JSON 데이터에 쿼리를 실행하여 전체 응답을 훑지 않고도 필요한 정보를 정확히 얻는 방법으로 생각해보세요.

왜 JSONPath를 사용할까요?

API로부터 거대한 JSON 응답을 받았다고 상상해보세요; 당신이 필요한 것은 깊은 곳에 중첩된 특정 필드의 값 뿐입니다. JSONPath가 없다면, 일반적으로 JSON을 구문 분석하기 위해 많은 코드를 작성해야 하는데, 이는 지루하고 오류가 발생하기 쉽습니다. JSONPath는 이를 단순화하여 정확히 추출하고 싶은 것을 지정할 수 있게 하여 코드를 더 깔끔하고 유지보수하기 쉽게 만들어줍니다.

JSONPath는 어떻게 작동하나요?

JSONPath는 복잡한 쿼리를 위해 몇 가지 추가 기능이 포함된 JavaScript 객체 표기법과 유사한 구문을 사용합니다. 기본 구문의 간략한 개요는 다음과 같습니다:

$: 루트 객체 또는 배열을 나타냅니다.
. 또는 []: 자식 연산자; 객체의 속성이나 배열의 요소에 접근하는 데 사용됩니다.
*: 와일드카드; 모든 요소나 필드와 일치합니다.
..: 재귀 하강; 어떤 수준에서든 일치하는 노드를 검색합니다.
?(): 필터를 적용합니다(식이 true로 평가되어야 함).
(): 기본 스크립트 엔진을 사용하는 스크립트 표현식입니다.

JSONPath가 어떻게 작동하는지 몇 가지 예를 통해 살펴봅시다.

기본 JSONPath 예제

영화 데이터베이스 API에서의 다음 JSON 데이터를 고려해봅시다:

{
  "movies": {
    "action": [
      { "title": "Mad Max: Fury Road", "director": "George Miller", "year":                  2015, "rating": 8.1 },
      { "title": "John Wick", "director": "Chad Stahelski", "year": 2014,                     "rating": 7.4 }
    ],
    "drama": [
      { "title": "The Shawshank Redemption", "director": "Frank Darabont",                   "year": 1994, "rating": 9.3 },
      { "title": "Forrest Gump", "director": "Robert Zemeckis", "year":                       1994, "rating": 8.8 }
    ],
    "comedy": [
      { "title": "The Grand Budapest Hotel", "director": "Wes Anderson",                     "year": 2014, "rating": 8.1 }
    ]
  }
}

모든 액션 영화 추출:

$.movies.action[*]

이 코드는 모든 액션 영화 객체의 배열을 제공합니다.

모든 드라마 영화의 제목 추출:

$.movies.drama[*].title

이 코드는 모든 드라마 영화의 제목 배열을 반환합니다: ["The Shawshank Redemption", "Forrest Gump"].

"Mad Max: Fury Road"의 평점 추출:

$.movies.action[?(@.title == "Mad Max: Fury Road")].rating

이 코드는 "Mad Max: Fury Road"의 평점을 반환합니다: 8.1.

2014년 개봉한 모든 영화 찾기:

$.movies..[?(@.year == 2014)]

이 코드는 2014년에 개봉한 모든 영화를 반환하며, 이 경우는: ["John Wick", "The Grand Budapest Hotel"]입니다.

API에서의 JSONPath

API에서 JSONPath를 사용하는 것은 JSON 응답에서 특정 정보를 추출하고자 할 때 매우 유용합니다. 많은 프로그래밍 언어와 도구에서 JSONPath를 지원하는 라이브러리를 가지고 있어 프로젝트에 쉽게 통합할 수 있습니다.

예를 들어, Javascript에서는 jsonpath 라이브러리를 사용할 수 있습니다:

const jsonpath = require('jsonpath');

// 샘플 JSON 데이터
const data = {
  movies: {
    action: [
      { title: "Mad Max: Fury Road", director: "George Miller", year: 2015, rating: 8.1 },
      { title: "John Wick", director: "Chad Stahelski", year: 2014, rating: 7.4 }
    ],
    drama: [
      { title: "The Shawshank Redemption", director: "Frank Darabont", year: 1994, rating: 9.3 },
      { title: "Forrest Gump", director: "Robert Zemeckis", year: 1994, rating: 8.8 }
    ],
    comedy: [
      { title: "The Grand Budapest Hotel", director: "Wes Anderson", year: 2014, rating: 8.1 }
    ]
  }
};

// 모든 드라마 영화의 제목 추출
const titles = jsonpath.query(data, '$.movies.drama[*].title');
console.log(titles); // 출력: ["The Shawshank Redemption", "Forrest Gump"]

마찬가지로, Python에서는 jsonpath-ng 라이브러리를 사용할 수 있습니다:

from jsonpath_ng import jsonpath, parse

# 샘플 JSON 데이터
data = {
    "movies": {
        "action": [
            {"title": "Mad Max: Fury Road", "director": "George Miller", "year": 2015, "rating": 8.1},
            {"title": "John Wick", "director": "Chad Stahelski", "year": 2014, "rating": 7.4}
        ],
        "drama": [
            {"title": "The Shawshank Redemption", "director": "Frank Darabont", "year": 1994, "rating": 9.3},
            {"title": "Forrest Gump", "director": "Robert Zemeckis", "year": 1994, "rating": 8.8}
        ],
        "comedy": [
            {"title": "The Grand Budapest Hotel", "director": "Wes Anderson", "year": 2014, "rating": 8.1}
        ]
    }
}

# 모든 드라마 영화의 제목 추출
jsonpath_expr = parse('$.movies.drama[*].title')
titles = [match.value for match in jsonpath_expr.find(data)]
print(titles)  # 출력: ["The Shawshank Redemption", "Forrest Gump"]

Apidog에서 JSONPath 사용하기

Apidog는 API 작업 프로세스를 단순화하도록 설계된 다목적 도구이며, 기본적으로 JSONPath를 지원합니다.

Apidog이 JSONPath의 힘을 효과적으로 활용할 수 있도록 도와주는 방법은 다음과 같습니다:

먼저, API에 요청을 보내고 Apidog를 통해 응답을 직접 확인해야 합니다. 그런 다음 제공된 인터페이스를 사용하여 응답에서 모든 액션 영화의 제목을 추출하기 위해 JSONPath 쿼리를 적용할 수 있습니다.

위 스크린샷에서 (1) 우리는 서버에 GET 요청을 보냅니다 - 나는 위에서 받은 JSON 데이터를 응답으로 사용하는 간단한 익스프레스 서버를 만들었습니다. 그런 다음 포스트 프로세서 탭(2)으로 전환하고 새로운 프로세스를 추가했습니다 - Variable 추출(3).

Variable 추출을 클릭하면 아래 페이지가 표시됩니다;

원하는 경우 변수 이름(1)을 설정할 수 있습니다. 변수는 다양한 API를 모니터링하거나 구축할 때 유용하며 일반 구성을 관리할 수 있는 단일 장소가 필요합니다. 여기의 변수는 .env 파일과 유사합니다.

다른 단계는 필터링하고자 하는 JSONPath를 입력하는 것입니다(2). 여기서는 JSON의 액션 배열에서 영화 제목을 가져오고자 합니다. 현재 경로를 입력한 후, 아래의 응답 페이지를 열기 위해 화살표 버튼(3)을 클릭합니다.

위 응답을 보면 Apidog가 액션 배열의 영화 제목을 필터링하여 우리에게 표시했습니다.

이 기능을 테스트해보고 싶다면, Apidog를 다운로드 및 설치하고 첫 요청을 보내보세요.

버튼

결론

JSONPath는 API의 JSON 응답에서 데이터를 탐색하고 추출하는 데 매우 유용한 도구입니다. 이는 복잡한 JSON 구조 작업을 단순화하여 개발 작업 흐름을 더 효율적으로 만들어줍니다. Apidog과 같은 도구와 JSONPath를 통합함으로써 필요한 정확한 데이터를 쉽게 필터링하고 검색할 수 있어 API 테스트 및 디버깅 과정을 향상시킬 수 있습니다. 영화 제목을 추출하든, 특정 레코드를 필터링하든, 응답을 검증하든, JSONPath는 JSON 데이터를 처리하는 명확하고 간결한 방법을 제공합니다. 다음 프로젝트에서 시도해보고 이 도구가 가져오는 간소화된 단순성을 경험해보세요.