2017-04-06 5 views
0

API Blueprint를 사용하여 API를 문서화하고 있으며 같은 값을 가진 동일한 열거 형을 사용하는 여러 끝점이 있습니다. 이 열거 형을 사용하는 모든 지점에서 모든 값을 반복하지 않고 데이터 구조 섹션에 넣고 싶습니다. 따라서이 구조를 DRY로 만듭니다. 그러나 문서에서 데이터 구조 섹션에 열거 형을 지정하는 방법을 알 수는 없습니다. 개체를 잘 처리 할 수 ​​있지만 데이터 구조 섹션에서 열거 형을 선언 할 때 지정된 멤버를 무시하는 것 같습니다.API 청사진에서 열거 형을 어떻게 만들 수 있습니까?

### Some Request [GET] 
+ Parameters 
    + name: `sample` (string) - the name 
    + type: `A` (enum[string]) - the type 
     + Members 
      + A 
      + B 
      + C 

### Another Request [GET] 
+ Parameters 
    + address: `123 St.` (string) - the address 
    + type: `B` (enum[string]) - the same type as above 
     + Members 
      + A 
      + B 
      + C 

그리고 여기에 내가 할 수 있도록하고 싶습니다 내용은 다음과 같습니다 : 여기

(즉 DRY되지 않습니다) 내가 지금 무엇을의 (매우 인위적인) 예제

### Some Request [GET] 
+ Parameters 
    + name: `sample` (string) - the name 
    + type: `A` (The Type) - the type 

### Another Request [GET] 
+ Parameters 
    + address: `123 St.` (string) - the address 
    + type: `A` (The Type) - the type 

# Data Structures 
## The Type (enum[string]) 
    + Members 
     + A 
     + B 
     + C 

나는이 구문에 몇 가지 변형을 시도했지만 모두 행운이 없다. 물론 내가 틀린 나무를 짖는 것만으로도 가능하고 반복되는 enum을 DRY로 만드는 완전히 다른 방법이 있습니다.

답변

2

URI 매개 변수에 MSON 구문을 사용하려고하는데이 문제는 아직 완전히 지원되지 않습니다. 역사적인 이유로 Paramters 섹션의 현재 구문은 Attributes 섹션의 구문과 만 정렬되지만 전체 기능 패리티는 없습니다. 이 RFC을 참조하십시오.

그래서 지금은 Parameters 섹션에서 MSON 상속 및 유형을 사용할 수 없습니다. 단순한 구조와 유형 만 사용할 수 있습니다.