Возможно ли в RAML указать связаный тип для top-level resource?

Question

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

Всем привет.

Изучаю RAML, сам пишу вывод API, есть необходимость сделать следующую вещь: при выводе раздела документации, касающегося ресурсов, вывести тип, который связан с каждым ресурсом. То есть, есть, например, ресурс /orders, я хочу, чтобы был такой вывод:

Orders (displayName)
дальше какое-то описание (description)

дальше описание типа Order с параметрами.
и дальше уже описание всех методов.

В спецификации RAML не нашел ни стандартной такой возможности, ни возможности указать кастомное поле при описании ресурса. Это вообще возможно?

Answer 1

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

Указание типа в ресурсе бессмысленно.
Хорошо работает вариант с ResourceType:

/Organizations:
  type: collection-item
  /{guid}:
    type: item

item:

#%RAML 1.0 ResourceType

description: Элемент <<resourcePathName | !singularize>>
uriParameters:
  guid:
    pattern: |
      [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
get:
  is: [secured]
  description: Получить элемент <<resourcePathName | !singularize>>
  responses:
    200:
      body:
        application/json:
          type: <<resourcePathName | !singularize>>
    404:
      description: Ресурс не найден

при выводе через API console линки работают нормально в RAML2HTML думаю тоже нормально отображаться будет.