如何在swagger規範中表示十進制浮點數？

Question

我想在我的api文檔中使用2位數和小數位來表示小數。我正在使用swagger 2.0，規範中是否有內置的定義類型或其他'round'參數，或者我唯一的選擇是使用'x-'擴展名？

Answer 1

OpenAPI（fka Swagger）規範使用JSON Schema的一個子集來描述數據類型。

如果該參數爲數字傳遞在this Q&A建議，您可以嘗試使用multipleOf：

type: number 
multipleOf: 0.1  # up to 1 decimal place, e.g. 4.2 
# multipleOf: 0.01 # up to 2 decimal places, e.g. 4.25 

Hovewer，對浮點數multipleOf驗證是不可靠的，由於floating-point math specifics。

如果你如果作爲一個字符串傳遞數量，可以爲所需的數字格式指定一個正則表達式pattern：

type: string 
pattern: your_regex 

在任何情況下，也可以口頭的description記錄任何限制。