⬇️ Код из карточек — Спецификация OpenAPI

openapi: 3.0.3
info:
title: Vet Clinic API
version: 1.0.0


paths:
/animals:
get:
summary: List animals
responses:
"200":
description: Animals list (polymorphic items)
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Animal"


components:
schemas:
Animal:
oneOf: # указывает, что объект Animal должен соответствовать одной (и только одной) из указанных ниже схем
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Dog"
- $ref: "#/components/schemas/Reptile"
discriminator: # дискриминатор
propertyName: species # используется поле species для определения типа
mapping: # маппинг схемы ответа для каждого вида животного в зависимости от значения species
cat: "#/components/schemas/Cat"
dog: "#/components/schemas/Dog"
reptile: "#/components/schemas/Reptile"


AnimalBase:
type: object
required: [id, name, species, ageYears, owner]
properties:
id:
type: string
name:
type: string
species:
type: string
description: Discriminator (animal kind). Will be extended
ageYears:
type: integer
owner:
$ref: "#/components/schemas/Owner"


Owner:
type: object
required: [id, fullName]
properties:
id:
type: string
fullName:
type: string


Cat:
allOf: # Используется для склейки AnimalBase и специфичных для Cat полей
- $ref: "#/components/schemas/AnimalBase"
- type: object
required: [species, felvStatus]
properties:
species:
type: string
enum: [cat]
felvStatus:
type: string
enum: [positive, negative, unknown]
description: FeLV test status


Dog:
allOf:
- $ref: "#/components/schemas/AnimalBase"
- type: object
required: [species, heightAtWithersCm]
properties:
species:
type: string
enum: [dog]
heightAtWithersCm:
type: integer
description: Height at withers in centimeters


Reptile:
allOf:
- $ref: "#/components/schemas/AnimalBase"
- type: object
required: [species, enclosureTempC]
properties:
species:
type: string
enum: [reptile]
enclosureTempC:
type: number
description: Enclosure temperature in Celsius