Versions Compared

Version Old Version 8 New Version 9
Changes made by

Hannah

Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ICE 내부 특정 NodeType에 대한 쿼리를 실행하기 위한 API 유형으로, 다음과 같은 추가적인 항목을 정의한다.

...

Expand
title"useCacheKey": false
Code Block
{
  "typeId": "api",
  "category": "snack",
  "apiId": "list",
  "apiName": "snack List",
  "apiType": "service",
  "method": "GET",
  "parameters": [
  ],
  "statistic": true,
  "aggregation": false,
  "root": {
    "configId": "root",
    "tid": "snack",
    "type": "query",
    "cacheable": true,
    "cacheTime": 60,
    "customResponse": "sampleResponse",
    "query": [
      {
        "method": "matchingShould",
        "field": "id",
        "value": "{{:id}}"
      },
      {
        "method": "matchingShould",
        "field": "name",
        "value": "{{:name}}"
      }
    ],
    "response": [
      {
        "field": "_all_",
        "type": "all"
      }
    ]
  }

{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=104&name=오레오

cacheKey api::snack>list?&id.matchingShould=104&name.matchingShould=오레오

Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 2,
    "totalTypeCount": 20,
    "resultCount": 2,
    "items": [
        {
            "id": "104",
            "label": "쿠크다스",
            "name": "쿠크다스",
            "idx": 1
        },
        {
            "id": "103",
            "label": "오레오",
            "name": "오레오",
            "idx": 2
        }
    ]
}

Expand
title"useCacheKey": true
Code Block
{
  "typeId": "api",
  "category": "snack",
  "apiId": "list",
  "apiName": "snack List",
  "apiType": "service",
  "method": "GET",
  "parameters": [
  ],
  "statistic": true,
  "aggregation": false,
  "root": {
    "configId": "root",
    "tid": "snack",
    "type": "query",
    "cacheable": true,
    "cacheTime": 60,
    "customResponse": "sampleResponse",
    "query": [
      {
        "method": "matchingShould",
        "field": "id",
        "value": "{{:id}}",
        "useCacheKey": false
      },
      {
        "method": "matchingShould",
        "field": "name",
        "value": "{{:name}}"
      }
    ],
    "response": [
      {
        "field": "_all_",
        "type": "all"
      }
    ]
  }
}

{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=104&name=오레오{{protocol}}://{{hostname}}:{{port}}/svc/snack/list?_siteId=bestshop&id=105&name=오레오

cacheKey api::snack>list?&name.matchingShould=오레오

cacheKey에서 id 제외

[ id=104, name=오레오 ] 로 검색 후 cacheKey에 60초간 캐싱

이후 [ id=105, name=오레오 ] 로 검색하더라도 60초간 응답결과는 변화가 없다.

Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 2,
    "totalTypeCount": 20,
    "resultCount": 2,
    "items": [
        {
            "id": "104",
            "label": "쿠크다스",
            "name": "쿠크다스",
            "idx": 1
        },
        {
            "id": "103",
            "label": "오레오",
            "name": "오레오",
            "idx": 2
        }
    ]
}

...

Include Page
query Method
query Method

Sample

Code Block
languagejson
{
  "typeId": "api",
  "category": "product",
  "apiId": "read",
  "apiName": "상품 조회",
  "apiType": "service",
  "method": "GET",
  "parameters": [
    {
      "parameter": "productId",
      "name": "상품ID",
      "valueType": "STRING",
      "required": true
    }
  ],
  "statistic": true,
  "aggregation": false,
  "root": {
    "configId": "root",
    "tid": "siteProduct",
    "type": "query",
    "resultType": "OBJECT",
    "cacheable": false,
    "cacheTime": 1,
    "allowParams": false,
    "orderNo": 1,
    "customResponse": "productReadResponse",
    "query": [
      {
        "method": "matching",
        "field": "id",
        "value": "{{:productId}}"
      },
      {
        "method": "matching",
        "field": "approvalStatus",
        "value": "approval"
      },
      {
        "method": "matching",
        "field": "saleStatus",
        "value": "selling"
      },
      {
        "method": "matching",
        "field": "exposure",
        "value": "true"
      },
      {
        "method": "matching",
        "field": "deleted",
        "value": "false"
      },
      {
        "method": "matching",
        "field": "site",
        "value": "{{:_siteId}}"
      }
    ],
    "response": [
      {
        "field": "id",
        "type": "field",
        "value": ""
      },
      {
        "field": "name",
        "type": "field",
        "value": ""
      },
      {
        "field": "siteProductSaleInfo",
        "type": "field",
        "value": ""
      },
      {
        "field": "optionType",
        "type": "field",
        "value": "baseProduct.productOptionInfo.optionType"
      },
      {
        "field": "productOptionCodes",
        "type": "field",
        "value": "baseProduct.productOptionInfo.productOptionCodes"
      },
      {
        "field": "productOptions",
        "type": "field",
        "value": "baseProduct.productOptionInfo.productOptions"
      },
      {
        "field": "productDetail",
        "type": "field",
        "value": "baseProduct.productDetail"
      },
      {
        "field": "images",
        "type": "field",
        "value": "baseProduct.images"
      },
      {
        "field": "videos",
        "type": "field",
        "value": "baseProduct.videos"
      }
    ]
  }
}