node.js上のswaggerのnullableフィールド

Question

Node.JSでスワッガードキュメントを作成するためのソリューションを見つけようと多くの時間を費やしました。メインライブラリはswagger-nodeであり、swagger yamlファイルを作成してコントローラを追加します。それは自動的にあなたのアプリにswigerのuiドキュメントを提供し、あなたのyamlで指定したモデルに対する応答&の要求に対する検証を行います。私はdate_sentを削除したくない

{ 
    id: 123, 
    description: "string", 
    date_sent: null 
} 

：

これはきちんとしている、しかし、私はいくつかのフィールドは、私は明示的に、たとえば、返したり値としてnullを受け入れることができるようにしたい要件を持っていますキー、私は明示的にヌルとしてそれを述べたいと思います。

swaggerの仕様では、anyOfがサポートされていません。これはJSONスキーマが通常これをどのように実行するかを表しています。

回避策があるのでしょうか？おそらく、追加できるベンダー固有のフラグx-nullableを持つノード用のライブラリがあります。また、不要なフィールドをすべてnullにできるように指定する方法もあります。

バリエーターミドルウェアが実行される前に自分のスワッガーファイルを取り出して修正するか、誰かが提案できる回避策がありますか？

Answer 1

SwaggerUIはnull可能な型をサポートしていません（hereを参照してください）。しかし、null可能なプロパティを次のように使用しました。

type: ['string','null'] 

その後、このプロパティはUIからは消えますが、検証は引き続き機能します。

Answer 2

nullableフィールドはOpenAPI（fka Swagger）仕様v3.0.0でサポートされていますが、v2.0ではサポートされていません。ヌル可能型は、次のように定義されます。

# Can be string or null 
type: string 
nullable: true 

Answer 3

typeプロパティにnullを追加する代わりに、代わりにdefaultプロパティを使用できます。

Swagger.jsonプロパティ定義の例：

"due_date": { 
    "type": "string", 
    "description": "Due date", 
    "default": "null" 
}, 

それが有効な闊歩型定義だし、まだ闊歩UIで期待どおりに表示されます。