Swagger APIドキュメントにSwashbuckleを使用してサブクラスを含めるにはどうすればよいですか？

Question

私はAsp.Net Web API 5.2プロジェクトをC＃で作成し、Swashbuckleでドキュメントを生成しています。

私は、Animal抽象クラスのAnimalプロパティとそこから派生するDogクラスとCatクラスのような継承を含むモデルを持っています。

SwashbuckleはAnimalクラスのスキーマしか示していないので、私はISchemaFilter（これも彼らが示唆していること）を試してみましたが、動作させることができず、適切な例も見つけられませんでした。

誰でも助けることができますか？

Answer 1

Swashbuckleはポリモーフィズムを正しく実装していないようですが、私はサブクラスについての作者の考え方をパラメータとして理解しています（もし、アクションがAnimalクラスを期待し、dogオブジェクトまたはcatオブジェクト2つの異なるアクションが必要です。）しかし、戻り値の型としてAnimalを返すのは正しいと考えられ、オブジェクトはDogまたはCat型になる可能性があります。

私のAPIを記述し、正しいguidlinesに沿って適切なJSONスキーマを生成するには（自分でディスクリミネータを記述する方法には注意してください。独自のディスクリミネータがあれば、特にその部分を変更する必要があります）次のように文書とスキーマフィルタは：。

{ 
    "definitions": { 
    "Pet": { 
     "type": "object", 
     "discriminator": "petType", 
     "properties": { 
     "name": { 
      "type": "string" 
     }, 
     "petType": { 
      "type": "string" 
     } 
     }, 
     "required": [ 
     "name", 
     "petType" 
     ] 
    }, 
    "Cat": { 
     "description": "A representation of a cat", 
     "allOf": [ 
     { 
      "$ref": "#/definitions/Pet" 
     }, 
     { 
      "type": "object", 
      "properties": { 
      "huntingSkill": { 
       "type": "string", 
       "description": "The measured skill for hunting", 
       "default": "lazy", 
       "enum": [ 
       "clueless", 
       "lazy", 
       "adventurous", 
       "aggressive" 
       ] 
      } 
      }, 
      "required": [ 
      "huntingSkill" 
      ] 
     } 
     ] 
    }, 
    "Dog": { 
     "description": "A representation of a dog", 
     "allOf": [ 
     { 
      "$ref": "#/definitions/Pet" 
     }, 
     { 
      "type": "object", 
      "properties": { 
      "packSize": { 
       "type": "integer", 
       "format": "int32", 
       "description": "the size of the pack the dog is from", 
       "default": 0, 
       "minimum": 0 
      } 
      }, 
      "required": [ 
      "packSize" 
      ] 
     } 
     ] 
    } 
    } 
}