У меня есть файловая структура, которая выглядит следующим образом:
Этот проект будет содержать API-документы для нескольких внутренних API от микросервисов.
Идея состоит в том, чтобы иметь общие типы для различных API, и в то же время отдельные типы, которые являются типичными для отдельных API.
Например, у меня есть общий тип с именем 'CoordType.raml':
#RAML 1.0 CoordType
type: object
properties:
lng:
displayName: lng
description: geolocation, longitude
type: number
format: double
lat:
displayName: lng
description: geolocation, latitude
type: number
format: double
Если я импортирую это в мой файл api.raml, например:
uses:
CoordType: !include ../common/types/CoordType.raml
И используйте это так:
/trending:
is: [traits.paged]
get:
description: Get trending items
queryParameters:
near_lat: CoordType.lat
near_lng: CoordType.lng
since: timestamp
responses:
200:
body:
application/json:
type: PostStatType
example: !include ./samples/GetTrending.json
Тогда это не совсем даст мне желаемый результат:
В идеалеЯ хотел бы просто включить общие типы в файл типов, специфичный для API (следовательно, файл api.raml будет по-прежнему включать только один файл).
К сожалению, я не могу найти правильный синтаксис дляэто, если это вообще возможно.
Есть совет?