指定我們在Apiary.io中的每個響應的描述

Question

是否可以爲每個對某個請求的響應指定描述？假設，我們有一個請求

### Retrieve resource [GET] 

    + Headers 

      If-None-Match: "Version1" 

而且2響應

+ Response 200 (application/xml) 

    + Headers 

      ETag: "Version2" 

    + Body 

      <Xml> 
       <A> 
        <B /> 
        <C /> 
       </A> 
      </Xml> 

+ Response 304 (application/xml) 

我想是指定的描述喜歡這裏（請注意：評論的權利下+ Response線）：

+ Response 200 (application/xml) 
In case if the resource hasn't changed 

    + Headers 

      ETag: "Version2" 

    + Body 

      <Xml> 
       <A> 
        <B /> 
        <C /> 
       </A> 
      </Xml> 

+ Response 304 (application/xml) 
In case if the resource has changed 

可能嗎？

Answer 1

目前無法在API藍圖中表達這樣的邏輯。你總是可以在相應的回答中或者在行動本身中「口頭」地描述它。例如：

# Resource [/1] 

## Action [GET] 

Explanation of this action here. 

+ Request 

     ... 

+ Response 200 

    Explanation of this response. 

    + Headers 

      ... 

    + Body 

      ... 

+ Response 304 

    Explanation of this response. 

    + Headers 

      ... 

請注意，爲了支持內容協商，很可能在不久的將來會有一些有限的分支支持。