API藍圖：語義問題

在我的藍圖，我定義的數據結構，並嘗試使用它像在文檔的末尾，以便API藍圖：語義問題

+ Attributes 

    + error: (Error Details, required)

數據結構定義「沒有指定值（S）」：

# Data Structures 

## Error Details 
+ code : 1234 (number, required) - see list of error codes 
+ message: User not found (string, required) - a human-readable error message

得到的樣本響應身體看起來就像是預期，但對apiary.io驗證顯示了每個地方我使用這樣結構的地方語義問題，他說「沒有規定值（S）」。

我做錯了什麼或與apiary.io解析器有問題嗎？

來源

2017-03-16 ma_il

屬性部分也可以定義爲+ Attributes <Type Definition>（specification），所以定義+ Attributes (Error Details, required)應該修復給定的語義問題。

編輯：

你必須忽略屬性的名稱和類型之間的冒號，如果沒有定義例子值：

+ Attributes 

    + error (Error Details, required)

錯過了之前，對不起。

來源

2017-03-16 14:59:14 izi

不幸的是，這隻會在這個非常具體的例子。例如，如果屬性類型是枚舉，則不會。我想避免在多個地方重複枚舉定義，但指定一個樣本值將在apiary.io的允許值列表中重複該值。 –

我現在有與ApiBlueprint相同的問題，這是解決我的問題。建設沒有任何錯誤或警告。

省略分號和單獨對象的定義和類型，如owner。

## Company (object) 
- name: Company name (string) 
- owner (OwnerResponse) (object)

希望它能幫助任何人。

來源

2017-08-04 04:06:24 daremachine

API藍圖：語義問題

回答

相關問題