Ich möchte Dezimal mit 2 Stellen und Dezimal mit 1 Stelle in meiner API-Dokumentation bezeichnen. Ich benutze Swagger 2.0, gibt es einen eingebauten definierten Typ oder irgendeinen anderen 'runden' Parameter in den Spezifikationen, oder meine einzige Option ist 'x-' Erweiterung zu verwenden?Wie kann ich Dezimal Gleitkomma in Swagger Specs bezeichnen?
OpenAPI (fka Swagger) Spezifikation verwendet eine Teilmenge von JSON Schema, um die Datentypen zu beschreiben.
Wenn der Parameter als Zahl übergeben wird, können Sie versuchen, multipleOf, wie in this Q&A vorgeschlagen:
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 Validierung gegen Gleitkommazahlen können aufgrund floating-point math specifics unzuverlässig sein.
Wenn Ihre Nummer, wenn als String übergeben, können Sie eine regex pattern für das gewünschte Zahlenformat angeben:
type: string
pattern: your_regex
In jedem Fall können Sie dokumentieren auch alle Einschränkungen verbal im description .