我的文件结构如下:
该项目将包含来自微服务的多个内部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文件仍将只包括一个文件)。
不幸的是,即使有可能,我似乎也无法为其找到正确的语法。
有什么建议吗?