Api-blueprint: Nullable 형식이 메서드 선언 내에서 작동하지 않습니다.

@danilvalov님 , Apiary는 null 허용 여부에 대한 지원을 추가하는 최신 버전의 API Blueprint Parser를 사용하지 않습니다.

Apiary에는 null 허용 여부에 대한 지원을 포함하여 속성 렌더링을 개선하기 위한 베타가 있습니다. 베타에 대한 자세한 내용은 https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764에서 참여 방법과 함께 확인할 수 있습니다.

문안 인사,

카일

저는 이것이 이제 Apiary(베타 없이)에 배포되었음을 지적하고 싶습니다.

예를 들어 다음과 같이 nullable을 사용할 수 있습니다.

+ Response 200 (application/json)
    + Attributes
        + example1 (string, optional, nullable) - An example optional nullable string
        + example2: value (string, optional, nullable) - An example optional nullable string with a sample value

그러면 다음과 같은 페이로드의 예가 됩니다.

{
  "example1": null,
  "example2": "value"
}

다음 JSON 스키마와 함께:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "example1": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string"
    },
    "example2": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string with a sample value"
    }
  }
}

Apiary 의 속성 테이블

이제 ApiaryUI 에서 볼 수 있습니다.