swagger.io에서 enum을 정의하는 방법은 무엇입니까?

Question

누구든지 swaggger 버전 2.0의 모델 탭에서 가능한 'enum'값을 정의 할 수 있습니까? 예 : http://petstore.swagger.wordnik.com/#!/pet/addPet에는 'status'속성에 대한 enum 옵션이 있지만이 예에서는 JSON 객체에 정의 된 swagger 버전에 따라 swagger 버전 1.0을 사용하고 있습니다. 버전 2.0에서도 동일한 결과를 얻으려고했지만 행운은 없었습니다. 설명서가 정확한지는 확실하지 않습니다.

여기에 대한 힌트가 있습니까?

Answer 1

은 "열거는"단지 다음과 같이 작동

 { 
     "in": "query", 
     "name": "sample", 
     "description": "a sample parameter with an enum value", 
     "type": "string", 
     "enum": [ "1", "2"], 
     "required": true 
     } 

당신이 볼 수 있듯이,이 String 형의 sample라는 쿼리 매개 변수, 그리고 두 가지 값을 명시 열거 있습니다. 이 경우 샘플에서는 매개 변수가 필요하므로 UI는 옵션으로 빈 값을 표시하지 않습니다. 당신이 당신의 자바 스크립트 (예 spec에 대한) 변수를 선언 할 수

{ 
    "swagger": "2.0", 
    "info": { 
    "title": "title", 
    "description": "descriptor", 
    "version": "0.1" 
    }, 
    "paths": { 
    "/sample": { 
     "post": { 
     "description": "sample", 
     "parameters": [ 
      { 
      "in": "query", 
      "name": "sample", 
      "description": "a sample parameter with an enum value", 
      "type": "string", 
      "enum": [ 
       "1", 
       "2" 
      ], 
      "required": true 
      } 
     ], 
     "responses": { 
      "200": { 
      "description": "Successful request." 
      } 
     } 
     } 
    } 
    } 
} 

가 로컬로 테스트하기 위해, 그리고 SwaggerUi 객체에 전달할 :

최소한의 작업 예제의 경우,이 시도.

var spec = { ... }; 

    window.swaggerUi = new SwaggerUi({ 
    url: url, 
    spec: spec, 
    dom_id: "swagger-ui-container", 
    supportedSubmitMethods: ['get', 'post', 'put', 'delete'], 
    onComplete: function(swaggerApi, swaggerUi){ 
    ... 

이 경우에는 url 매개 변수가 무시됩니다.

결국, 결과는 다음과 같다 :

나는 괜찮 이런 식으로 할 수 있었다, 그러나 당신은 각이 드롭 다운 만든 PARAMS은 아래 첨부 된 이미지를 볼 수 있습니다 :

을

내가 달성하고 싶은 것은 멋지다. Model/Model Schema 탭은 아래 그림에서 사용 가능한 enum이 매개 변수에 대해 나열되어 있습니다.

Answer 2

이 작동합니다 : :이 자신감의 최신 버전에서 가능한

{ 
    "name": "bookingType", 
    "in": "path", 
    "type": "array", 
    "items": { 
     "enum": [ 
      "packages", "accommodations" 
     ] 
    }, 
    "description": "lorem ipsum" 
} 

참조 https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#itemsObject

Answer 3

를이 정확한 답은 아니지만, 때까지 당신을 위해 작동하지 않을 수 있습니다 그들은이 기능을 추가합니다.

단순히 ModelSchema가 {}을 보여줍니다 그래서

"MyObject":{ 
    "properties":{ 
     "MyEnum":{ 
     "type":"Value1 or Value2 or Value3" 
     } 
    } 
} 

같은 속성을 선언하지만,이 모델은 YAML의 구문이 업데이트 MyEnum(Value1 or Value2 or Value3, optional)

Answer 4

표시됩니다 :

in: query 
name: sample 
description: a sample parameter with an enum value 
type: string 
enum: 
    - 1 
    - 2 
required: true