Ich versuche, in meinem mson folgenden Beispiel in der Dokumentation einen nullbaren Typ zu verwenden, aber es schlägt mit einem semantischen Fehler fehl.
Bitte helfen Sie mir herauszufinden, was mit meinem mson nicht stimmt und wie ich die richtige Dokumentation für meinen Anwendungsfall erstellen kann.
Vielen Dank!
Hallo @danilvalov , Apiary verwendet nicht die neueste Version des API Blueprint
Apiary verfügt über eine Betaversion zur Verbesserung des Rendering von Attributen, die die Unterstützung für NULL-Zulässigkeit umfasst. Weitere Informationen zur Beta finden Sie unter https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 und wie Sie daran teilnehmen können.
Grüße,
Kyle
Ich möchte nur darauf hinweisen, dass dies jetzt für Apiary bereitgestellt wurde (ohne Beta).
Als Beispiel können Sie nullable wie folgt verwenden:
+ Response 200 (application/json)
+ Attributes
+ example1 (string, optional, nullable) - An example optional nullable string
+ example2: value (string, optional, nullable) - An example optional nullable string with a sample value
Wobei dies zu einer Beispielnutzlast der folgenden führen würde:
{
"example1": null,
"example2": "value"
}
Zusammen mit dem folgenden JSON-Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"example1": {
"type": [
"string",
"null"
],
"description": "An example optional nullable string"
},
"example2": {
"type": [
"string",
"null"
],
"description": "An example optional nullable string with a sample value"
}
}
}
Die Attributtabelle in Apiary erwähnt noch nicht, dass der Wert nullable ist , aber das kommt noch.
Dies ist jetzt in ApiaryUI sichtbar:
Hilfreichster Kommentar
Ich möchte nur darauf hinweisen, dass dies jetzt für Apiary bereitgestellt wurde (ohne Beta).
Als Beispiel können Sie nullable wie folgt verwenden:
Wobei dies zu einer Beispielnutzlast der folgenden führen würde:
Zusammen mit dem folgenden JSON-Schema:
Die Attributtabelle in Apiary erwähnt noch nicht, dass der Wert nullable ist , aber das kommt noch.