Как отобразить пайтон класс в Swagger UI?

Question

[Maxwell012]

Есть код:

from datetime import datetime
from typing import Optional, Type
from enum import Enum
from pydantic import BaseModel, Field


class StatusSchema(str, Enum):
    PAYING: str = "paying"
    TRANSFERRING: str = "transferring"
    DONE: str = "done"
    DISPUTE: str = "dispute"


class OrderSchema(BaseModel):
    buyer_id: int
    seller_id: int
    amount: int = Field(ge=0)
    status: str = StatusSchema.PAYING
    buyer_confirmation_date: Optional[datetime] = None
    seller_confirmation_date: Optional[datetime] = None
    transaction_hash: Optional[str] = None
    dispute_id: Optional[int] = None


class OrderSchemaAdd(BaseModel):
    buyer_id: int
    seller_id: int
    amount: int = Field(ge=0)

OrderSchemaAdd - отображается в свагере, но OrderSchema не отображается. Можно предположить что это происходит из-за того что одна из переменных в классе ссылается на другой класс, но попытки убрать его ничем не помогли. Что только я не пробовал сделать с классом StatusSchema я его и убирал и помещал внутрь класса ордера и ничего не помогало.

Вопросы:
- Что я делаю неправильно, почему класс не отображается в Swagger UI?
- Прошу совет, как правильно хранить переменную status чтобы не мучать себя и других?

Comments

[Everything_is_bad]

на основе описания роутеров делается отображение, но ты этого не показываешь

[Everything_is_bad]

и если у тебя такое описание схем, значит ты плохо читал доки https://fastapi.tiangolo.com/tutorial/extra-models... про разделение ввода и вывода https://fastapi.tiangolo.com/tutorial/response-mod...

[Maxwell012]

Everything_is_bad, спасибо за ответ, напиши как ответ я отмечу как решение

[Maxwell012]

Everything_is_bad, не совсем понимаю что не так с моими схемами, у меня есть схема вывода (OrderSchema) и схема входа (OrderSchemaAdd). Разве что я могу создать еще базовую схему в которой будет хеш транзакции, а в схеме вывода не будет ее

[Everything_is_bad]

Maxwell012, "не так" в них дублирование полей

[Maxwell012]

Everything_is_bad, мне теперь наследоватся от схемы добавления?

[Maxwell012]

Maxwell012, или писать еще третию которая эти поля содержит в себе и уже ее делать родительским классом?

[Everything_is_bad]

Maxwell012, ну так подумай, пример в ссылках на доки есть

[Maxwell012]

Everything_is_bad,

from datetime import datetime
from typing import Optional, Type
from enum import Enum
from pydantic import BaseModel, Field


class OrderSchemaBase(BaseModel):
    buyer_id: int
    seller_id: int
    amount: int = Field(ge=0)


class StatusSchema(str, Enum):
    PAYING: str = "paying"
    TRANSFERRING: str = "transferring"
    DONE: str = "done"
    DISPUTE: str = "dispute"


class OrderSchemaOut(OrderSchemaBase):
    status: StatusSchema = StatusSchema.PAYING
    buyer_confirmation_date: datetime | None = None
    seller_confirmation_date: datetime | None = None
    dispute_id: int | None = None


class OrderSchemaFromDB(OrderSchemaBase):
    transaction_hash: str | None = None


class OrderSchemaIn(OrderSchemaBase):
    ...

Что скажешь, лучше?

[Everything_is_bad]

Maxwell012, без понятия, тебе же с этим работать, откуда я знаю нужны ли тебе все эти схемы или в каком месте, какие должны быть доступные поля

[Maxwell012]

Everything_is_bad, ну я спрашиваю в плане чистоты кода, сейчас же ничего не дублируется

[Everything_is_bad]

Maxwell012, дублирование так же зависит от использования, может у тебя в FromDB или Out будет уже не buyer_id, а тоже схема

[Maxwell012]

Everything_is_bad, натолкнул на мысыль, у меня в коде возвращается сущность поокупателя а не айди, я чет об этом даже не подумал. Благодарю еще раз получается)