믹스 요청/응답 본문 및 데이터 구조

Question

새 API에 대한 훌륭한 설명서를 만들려면 aglio/api 청사진을 사용하고 싶습니다.

JSON이 매우 큽니다 (선택 값이 많음). 따라서 본문에서 적절한 유스 케이스를 제공하고 싶지만 json 스키마에도 데이터 구조를 사용하고 싶습니다. 그러나 스키마가 본문과 정확히 일치 할 때마다 예제 데이터를 입력하지 않았기 때문에 결과 HTML에서 "Hello, world!"가 throw됩니다.하지만 본문에서 완전하고 유효한 예제를 얻은 이후 , 나는 aglio가 Hello World 출력을 만들 것을 기대하지 않았을 것입니다.

{ 
    "a": "i want this to appear", 
    "b": "in my aglio", 
    "c": "html file" 
} 

이 실제로 나타나지 않는 것입니다 :

참고로

, 그게 내가 표시 결과 htmls 몸에 기대하는 무엇

{ 
    "a": "Hello, world!", 
    "b": "Hello, world!", 
    "c": "Hello, world!", 
    "d": "Hello, world!" 
} 

을 그리고 그 원시 API를 청사진이다 :

FORMAT: 1A 

# JSON Schema 

# Test [/post/something] 

## A Test [POST] 

+ Request (application/json) 
    + Attributes (SomeObject) 

    + Body 

     { 
      "a": "i want this to appear", 
      "b": "in my aglio", 
      "c": "html file" 
     } 

+ Response 200 

# Data Structures 
## SomeObject (object) 
+ a (string) - A 
+ b (string) - B 
+ c (string) - C 
+ d (string, optional) - I'm optional, yet don't want to appear in the html, only the schema 

그래서 처음에는 일을하는 올바른 방법입니까? 다른 접근 방법을 권하고 싶습니까? 이것이 apiary에서 내가 의도 한대로 작동하기 때문에 이것은 aglio의 버그입니까? 감사합니다.

Answer 1

해당 github 문제를 찾았습니다. 내 설명에 문제가없는 것처럼 보입니다. https://github.com/danielgtaylor/aglio/issues/221

Answer 2

다음과 같은

FORMAT: 1A 
# JSON Schema 
# Test [/post/something] 
JSON Schema Title 
## A Test [POST] 

+ Request (application/json) 
    + Attributes (object) 
     + a a-value (string, required) - description about a 
     + b b-value (number, required) - description about b 
     + c c-value (string, required) - description about c 
     + d [a1, a2, a3] (array, optional) - I'm optional 

+ Response 200 (application/json) 
    { 
    "message": "this works" 
    } 

A A 값 (문자열, 필수) 할 수 - 위의 줄에 설명 "A"-> 속성 이름을 "A-값"-> "description"-> 스키마 속성 설명