JSON Hyper-Schema : GET 및 POST에 대한 다른 스키마

Question

항목을 게시 할 때 여러 가지 값을 정의 할 수있는 필드가있는 API를 설명하고 싶지만 특정 방식으로 필드에 출력해야합니다.

예를 들어, {"name": "Task", "due": "2014-12-31"} 또는 {"name": "Task", "due": {"$date": 1419984000000}}과 같이 항목을 만들거나 업데이트 할 수있는 API를 설명하고 싶지만 첫 번째 방법으로는 API에서만 반환됩니다.

POST/PUT의 스키마 그러므로 수 :

이

{ 
    "type": "object" 
    "properties": { 
     "name": { 
      "type": "string" 
     }, 
     "due": { 
      "type": "string", 
      "format": "date" 
     } 
    } 
} 

그것은 API의 소비자에게 좋은 것 :

GET을 통해 액세스에 대한 스키마 반면

{ 
    "type": "object" 
    "properties": { 
     "name": { 
      "type": "string" 
     }, 
     "due": { 
      "oneOf": [ 
       { 
        "type": "string", 
        "format": "date" 
       }, 
       { 
        "type": "object", 
        "properties": { 
         "$date": { 
          "type": "number" 
         } 
        }, 
        "required": ["$date"], 
        "additionalProperties": false 
       } 
      ] 
     } 
    } 
} 

훨씬 간단 할 것 그들 모두가 아니라 한 가지 가능한 출력 방법을 설명하면된다는 것을 알 수 있습니다.

JSON Hyper-Schema의 컨텍스트 내에서 다른 스키마를 지정하는 데 허용되는 표준 접근 방식이 있습니까? "links" 속성을 통해 이러한 차이점을 지정하는 방법에 대해 생각해 보았습니다.하지만 "rel"이 스키마를 정의 할 수 없다는 것을 알지 못합니다. 매우 비표준적인 것으로 보입니다.

Answer 1

제대로 이해하고 작업 당 하나의 스키마를 지정하려는 경우 표준 하이퍼 스키마로 수행 할 수 있습니다. 게시 작업을 보자. 예제 :

{ 
    "description": "create an item.", 
    "href": "/items", 
    "method": "POST", 
    "rel": "create", 
    "schema": { 
    "$ref": "#/api/createitem" 
    }, 
    "title": "Create an item" 
} 

실제 스키마는 "$ ref"를 통해 "스키마"속성에서 참조됩니다.

응답 유형을 설명하려면 "targetSchema"속성을 사용할 수 있습니다. 이것은 단지 조언이됨을 유의하십시오 (explained in the docs)