Question

我有一个关于RAML（RESTful Api建模语言）的简单问题。我想尝试新的东西，以便为我的API创建文档（以后再进行测试）。 API是用node.js。

编写的

我应该将我的整个代码包含在api.raml文件中吗？或者是否可以从其他.raml文件导入子路由？有没有什么好的指导如何划分.raml文件？

e.g。我想创建一个名为/books的文件。它将包括api.raml下的所有路线。然后我想在我的{{1}}中导入它，所以它更像是一个只包含子文件的文件。

可以吗？如果是，我怎么能这样做？关于存储这些文件的位置（在哪个目录中）有什么指导？

Answer 1

您可以将RAML规范划分为多个文件，并使用！include 指令来包含文件。

例如：

#%RAML 1.0
title: My API with Types
types: !include myTypes.raml

有关包含here

的详细信息

此外RAML提供了库：＆＃34; RAML库用于将任何数据类型声明集合，资源类型声明，特征声明和安全方案声明组合成模块化，外部化，可重用的组＆＃34;

使用内容和使用方法取决于您的使用案例。但我认为图书馆可以提供更好/更有意义的结构。

查看有关modularization的部分以获取更多信息。

您还可以包含您所说的路线，例如：

#%RAML 1.0
title: bla
/foo/:
  /bar/:
    post:
    get:
/books: !include books.raml

但我不确定这是构建RAML的好方法。