JSONPath

JSONPath는 XML에서 XPath가 작동하는 방식과 유사하게, JSON 데이터 구조에서 정보를 추출하도록 설계된 쿼리 언어입니다. Apidog에서는 API 응답에서 값을 추출하고, 데이터를 검증하며, 동적 테스트 어서션을 생성하는 데 JSONPath가 광범위하게 사용됩니다.

Apidog에서 활용되는 JSONPath 버전은 JSONPath Plus를 기반으로 합니다. 더 자세한 구문 설명은 제공된 링크를 참조하실 수 있습니다.

AI 기반 JSONPath 생성기

JSONPath에 익숙하지 않으신 경우, 이 무료 AI 도구를 사용하여 표현식을 생성하실 수 있습니다.

빠른 시작

JSON 응답 예시

다음과 같은 JSON 응답이 있다고 가정해 보겠습니다.

{
    "store": {
      "book": [
        { "category": "fiction", "author": "Author A", "title": "Book 1" },
        { "category": "reference", "author": "Author B", "title": "Book 2" },
        { "category": "fiction", "author": "Author C", "title": "Book 3" }
      ]
    }
}

데이터 추출

배열에서 첫 번째 book의 title을 추출하려면 다음 JSONPath 표현식을 사용하십시오.

 $.store.book[0].title

이 표현식은 "Book 1"을 반환합니다.

JSONPath 표현식 설명

$.store.book[0].title 표현식을 세분화하여 살펴보겠습니다.

$: JSON 문서의 루트 노드를 가리킵니다. 즉, 전체 구조를 의미합니다.

store: 루트 노드 아래의 객체인 store 속성을 가리킵니다.

book: store 객체 아래의 book 속성에 접근합니다. 이 속성은 배열입니다.

[0]: book 배열에서 첫 번째 요소를 선택합니다. 인덱스는 0부터 시작합니다.

title: 배열의 첫 번째 책에서 title을 가져옵니다.

요약하면, 이 표현식은 루트에서 시작하여 store 객체를 찾고, book 배열에 접근한 다음, 첫 번째 항목을 선택하여 해당 항목의 title을 추출합니다.

중요 참고 사항

JSONPath 인덱스는 0부터 시작합니다.

JSONPath의 문자열은 작은따옴표를 사용해야 합니다. 예: $.store.book[?(@.category=='reference')].

구문 개요

기본 구문

Syntax	Description
`$`	루트 노드
`@`	현재 노드
`.node` or `['node']`	자식 노드에 접근
`[index]`	배열 인덱싱, `0`부터 계산하는 방식을 지원합니다
`[start:end:step]`	배열 슬라이싱
`*`	와일드카드, 모든 자식 노드와 일치합니다
`..`	재귀 와일드카드, 모든 하위 항목과 일치합니다
`(<expr>)`	동적 표현식
`?(<boolean expr>)`	필터 조건

확장 구문

Syntax	Description
`^`	일치하는 항목의 부모에 접근합니다
`~`	일치하는 항목의 속성 이름을 가져옵니다(배열로 반환)
`@null()`, `@boolean()`, `@number()`, `@string()`, `@array()`, `@object()`	기본 JSON 타입을 가져옵니다
`@integer()`	정수 타입을 가져옵니다
`@scalar()`	복합 타입을 가져오며, `undefined` 및 유한하지 않은 숫자를 허용합니다(JavaScript 객체를 쿼리할 때)
`@other()`	사용자 정의 `otherTypeCallback`과 함께 사용할 수 있습니다
`@undefined()`, `@function()`, `@nonFinite()`	JSON이 아닌 JavaScript 객체를 쿼리할 때 사용되는 비 JSON 타입입니다
`@path`, `@parent`, `@property`, `@parentProperty`, `@root`	필터의 단축 선택자입니다
`	나머지 시퀀스를 이스케이프합니다
`@['...']`, `?@['...']`	필터 내 속성 이름의 특수 문자를 이스케이프합니다
`$..`	모든 부모 구성 요소를 가져옵니다

JSONPath 예시

다음은 예시 JSON 데이터를 기반으로 한 일반적인 JSONPath 표현식입니다.

예시 JSON 데이터

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      },
      {
        "category": "fiction",
        "author": "J. R. R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  }
}

일반적인 쿼리 예시

XPath	JSONPath	Result
`/store/book/author`	`$.store.book[*].author`	모든 책의 저자
`//author`	`$..author`	모든 저자
`/store/*`	`$.store.*`	`store` 아래의 모든 자식 노드
`/store//price`	`$.store..price`	모든 price 필드
`//book[3]`	`$..book[2]`	세 번째 책(0 기반 인덱스)
`//book[last()]`	`$..book[(@.length-1)]` or `$..book[-1:]`	마지막 책
`//book[position()<3]`	`$..book[:2]` or `$..book[0,1]`	처음 두 권의 책
`//book[isbn]`	`$..book[?(@.isbn)]`	ISBN이 있는 책
`//book[price<10]`	`$..book[?(@.price<10)]`	가격이 10 미만인 책
`//*`	`$..*`	모든 자식 노드를 재귀적으로 일치시킵니다

JSONPath 표현식 테스트

JSONPath tester를 사용하여 이러한 표현식을 검증하실 수 있습니다. 검증을 위해 반드시 JSONPath Plus를 선택하십시오.

Apidog에서의 사용 사례

JSONPath는 Apidog에서 특히 다음 용도로 유용합니다.

응답 검증: API 응답에서 특정 값을 추출하여 정확성을 확인합니다

동적 변수: 추출한 값을 후속 요청에서 사용할 수 있도록 저장합니다

테스트 어서션: 응답 데이터를 기반으로 강력한 어서션을 생성합니다

데이터 추출: 복잡한 중첩 JSON 구조에서 특정 필드를 가져옵니다

참고 자료

JSONPath Plus

JSONPath - XPath for JSON

Querying JSON with SelectToken

빠른 시작#

구문 개요#

기본 구문#

확장 구문#

JSONPath 예시#

예시 JSON 데이터#

일반적인 쿼리 예시#

Apidog에서의 사용 사례#

참고 자료#

빠른 시작

구문 개요

기본 구문

확장 구문

JSONPath 예시

예시 JSON 데이터

일반적인 쿼리 예시

Apidog에서의 사용 사례

참고 자료