Как в RAML убрать некоторые параметры из типа, который используется для тела запроса?

Question

[Антон Иванов]

Всем привет.

Использую RAML 1.0
Есть тип Order с некоторыми полями, в том числе и id.
Есть POST запрос к /orders, в теле которого передается объект "Order", но без поля id.
Можно ли как-то исключить это поле из списка полей типа для тела запроса?

то есть, этот тип указан и как тип для тела запроса и как тип структуры ответа. Использовать 2 разных типа, или inline описание не хочется, так как у типа Order все поля с описаниями и это будет дублирование 80% информации. Можно еще создать тип OrderRequest и наследовать его в Orders, но это тоже какой-то костыль...

Есть ли какое-то решение?

Answer 1

[Станислав Макаров]

создать тип OrderRequest и наследовать его в Orders, но это тоже какой-то костыль...

Согласен. Но почему бы не наследовать и Order и OrderRequest от OrderInfo, в котором будут все общие поля?

Comments

[Антон Иванов]

Не очень понимаю отличие такого решения от предложенного мной. В OrderRequest и так будут все общие поля, а в Order будет OrderRequest + id.

[Станислав Макаров]

Антон Иванов отличие будет в том, что у вас Order не будет наследоваться от OrderRequest, что есть, как вы сказали, костыль. Так вы сможете и в Order, и в OrderRequest добавить по необходимости свои поля, и у вас не будет так, что всё без исключения содержимое OrderRequest всегда попадает в Order.

[Антон Иванов]

Станислав Макаров: Ну это понятно. Но сейчас мне как раз нужно, чтобы все, что есть в OrderRequest, попадало в Order.

[Станислав Макаров]

Антон Иванов почему вы тогда считаете, что это костыль?
Я считаю, что это костыль, потому что если вам что-то нужно будет добавить именно в request, но не в order, вы не сможете это сделать. Запрос имеет право иметь дополнительную информацию, которая не должна быть в уже созданном order. OrderInfo вы создаете специально для того, чтобы там были именно общие поля.
Нужно думать не только о том, что по факту получается ПРЯМО СЕЙЧАС, но и подумать, как ваши сущности смогут изменяться в будущем. Тогда сразу станут видны некоторые неестественные зависимости.

[Станислав Макаров]

Антон Иванов собственно, а какое решение вы хотите? Вы хотите, чтобы поля не нужно было дублировать, но не хотите выносить что-либо в отдельную сущность. Создаётся впечатление, что вы уже ждёте чего-то конкретного. Озвучьте тогда)

[Антон Иванов]

Станислав Макаров: Ну да )) Конкретика озвучена в самом вопросе :)
"Можно ли как-то исключить это поле из списка полей типа для тела запроса?"

[Антон Иванов]

Станислав Макаров: Насчть разных типов для запроса и для объекта с одним предком, да, согласен, имеет смысл так сделать

Answer 2

[Александр Маликов]

RAML 1.0 поддерживает наследование от нескольких типов:

#%RAML 1.0
title: Example API
version: v1

types: 
  Order:
    type: object
    properties: 
      id:
        type: integer
      date:
        type: integer

  Ext_type:
    type: object
    properties: 
      ext_type_property:
        type: string

  Order_ext:
    type: [Order,Ext_type]

API console обработал корректно
Что будет при "смешивании" различных типов не проверял.