먼데이닷컴을 통한 업무 혁신 사례를 확인해 보세요 🚀

글로벌 No.1 협업툴, 먼데이닷컴

먼데이닷컴 국내 유일 플래티넘 파트너 IFIED

요금안내 체험판 신청

먼데이닷컴 FAQ

FAQ 목록

    GraphQL 살펴보기

    먼데이닷컴 API는 GraphQL으로 구축 되어있습니다. GraphQL은 사용자가 필요한 만큼의 데이터를 반환할 수 있는 유연한 쿼리 언어입니다. GraphQL의 기초에 대한 자세한 내용은 GraphQL의 개요 문서를 참조하세요.

    여러 엔드포인트가 서로 다른 데이터를 반환하는 REST API와 달리  GraphQL은 단일 엔드포인트를 가지고 있으며, 반환하는 데이터 구조를 결정할 수 있습니다.

    API 엔드포인트는 다음과 같습니다. : https://api.monday.com/v2

    GraphQL은 자료형 체계에 의존하며, 각 객체는 유형이며 이를 정의하는 필드가 포함됩니다. 이러한 필드는 스칼라(정수 등)이거나 객체 자체일 수 있습니다. 일부 필드에서는 반환하는 데이터를 제한, 필터링 또는 정렬하는 데 사용할 수 있는 인자도 있습니다.



    작동 방식

    GraphQL에는 두 가지의 방식이 있습니다. 쿼리(query)와 뮤테이션 (mutation)입니다.


    쿼리(query)

    쿼리는 읽어오는 (READ) 를 수행합니다. 각 쿼리의 결과는 요청 쿼리오 동일한 구조로 돌아옵니다.

    아래의 예시로 확인해 보세요

    예시 쿼리

    query {
  boards {
    columns {
      id
      title
      type
    }
  }
}

    예시 응답

    {
        "columns": [
          {
            "id": "name",
            "title": "Name",
            "type": "name"
          },
          {
            "id": "subitems",
            "title": "Subitems",
            "type": "subtasks"
          },
          {
            "id": "person",
            "title": "Person",
            "type": "people"
          },
          {
            "id": "status",
            "title": "Status",
            "type": "status"
          }
        ]
      },


    뮤테이션( Mutation)

    뮤테이션은 특별한 쿼리로써, CREATE,UPDATE, DELETE를 수행합니다.뮤테이션은 여러분이 수정한 객체를 반환합니다.

    아래의 예시는 새로운 아이템을 1234567890 보드에 생성하는 쿼리입니다.

    예시 뮤테이션

    mutation{
  create_item (board_id: 1234567890, item_name: "New Item"){
    id
    name
  }
}


    응답

    {
  "data": {
    "create_item": {
      "id": "9876543210",
      "name": "New Item"
    }
  },
  "account_id": 12345678
}


    하나의 요청에 다중 쿼리/뮤테이션 사용 방법


    하나의 요청에 여러 개의 쿼리를 전송할 수 있으며, 차례로 처리됩니다.
    첫 번째 예시 쿼리와 응답은 1234567890 보드 9876543210 보드의 이름과 ID를 요청하며 반환합니다.
    두 번째 예시에서는 두 보드에서 새로운 아이템을 생성 요청하고  ID를 반환합니다.


    예시 쿼리 

    query {
  checkBoard1: boards (ids:1234567890) {
    id
    name
  }
  checkBoard2: boards (ids:9876543210) {
    id
    name
  }
}

    응답 

    {
  "data": {
    "checkBoard1": [
      {
        "id": "1234567890",
        "name": "Test Board 1"
      }
    ],
    "checkBoard2": [
      {
        "id": "9876543210",
        "name": "Test Board 2"
      }
    ]
  },
  "account_id": 1234



    예시 뮤테이션

    mutation{
  createItem1: create_item (board_id: 1234567890, item_name:"Test Item 1") {
    id
    name
  }
  createItem2: create_item(board_id: 9876543210, item_name:"Test Item 2") {
    id
    name
  }
}

    응답 

    {
  "data": {
    "createItem1": {
      "id": "11223344",
      "name": "Test Item 1"
    },
    "createItem2": {
      "id": "44332211",
      "name": "Test Item 2"
    }
  },
  "account_id": 12345678
}


    객체(Object) 유형

    객체 유형은 API를 사용하여 쿼리할 수 있는 가능한 데이터 집합을 설명하는 데 사용되는 필드의 모음입니다. 또한 데이터를 쿼리할 때 매개 변수를 전달하기 위해 필드에 인수를 지정할 수 있습니다.


    필드 (Field)

    필드는 쿼리에서 검색할 정보를 정의하는 데 도움이 되는 개체의 속성 또는 속성을 지정합니다. 스키마의 모든 객체에는 이름으로 쿼리할 수 있으며 개체의 특정 속성을 검색할 수 있는 필드가 포함되어 있습니다.

    예를 들어, board 객체는 보드에 대한 특정 정보를 반환할 수 있습니다. 다음 예제에서는 보드의 ID와 이름, 보드의 각 열의 ID, 제목 및 유형을 반환합니다.

    query {
    boards {
        id
    name
    columns {
      id
      title
      type
    }
  }
}


    인수(Argument)

    쿼리에서 인수를 전달하여 반환할 데이터를 지정하고(즉, 검색 결과 필터링) 결과를 원하는 특정 데이터로만 좁힐 수 있습니다.

    위의 보드 예제를 기반으로 이러한 인수를 사용하여 쿼리에 반환되는 결과 수를 줄일 수도 있습니다. 다음 예제에서는 보드 1234567890 및 9876543210의 ID와 이름, 보드의 각 열의 ID, 제목 및 유형만 반환합니다.

    query {
    boards (ids: [1234567890, 9876543210]) {
        id
    name
    columns {
      id
      title
      type
    }
  }
}


    변수(Variables)

    변수를 사용하여 동적 값을 인수에 전달할 수 있습니다.

    변수 를 사용하기 위해서는, 다음 세 가지 작업을 수행해야 합니다:

    1. 쿼리의 정적 값을 $variableName으로 바꿉니다
    2. 쿼리에서 허용하는 변수 중 하나로 $variableName  선언
    3. variableName: value 를 분리하여 특정 전송할 타입을 지정하여 별도로 전송합니다.
    mutation change_column_value($value: JSON!) {
    change_column_value (board_id: 157244624,item_id: 9539475, column_id: "status", value: $value) {
        id
    }
}

query variables:
{
"value": "{\"index\": 1}"
}


    GraphQL visual interface (GraphiQL)

    GraphQL의 강점 중 하나는 시각 인터페이스인 GraphiQL입니다. GraphQL 쿼리를 작성, 검증 및 테스트하기 위한 브라우저 내 도구입니다.

    API를 적용하기 전, API 플레이그라운드의 이 시각적 인터페이스를 통해 쿼리를 실행하여 쿼리가 정확하고, 예상한 데이터가 반환 되는 지 확인해보세요.

    API playground

    먼데이닷컴 계정을 통해 API 플레이그라운드를 사용할 수 있습니다. 다음 하위 섹션에서는 두 가지 방법을 통해 놀이터에 접근하는 방법을 설명합니다.

    일반 playground

    1. playground로 이동합니다.
    2. API token을 입력하여 인증합니다.
    3. 쿼리를 테스트해 보세요!

    계정을 통한 playground

    1. 우측 상단의 프로필을 클릭합니다.
    2. 개발자 모드 클릭 합니다.
    3. 왼쪽 메뉴의 API playground를 클릭합니다. 계정에 로그인 되어 있어, 추가 인증이 필요하지 않습니다.
    4. 쿼리 테스트를 시작합니다.


    먼데이닷컴의 스키마

    GraphQL 스키마는 사용 가능한 API 데이터의 구조를 정의하며 사용할 수 있는 모든 가능한 쿼리와 돌연변이를 포함합니다. API 응답을 확인하고 메타데이터에서 유용한 정보를 추출하는 데 사용할 수 있는  리소스 입니다.

    이곳에서 스키마를 확인해 보세요


    최근 업데이트 일자 : 2023. 07. 26