api.ramlにはAPI全体が含まれていますか？

Question

私はRAML（RESTfulなApiモデリング言語）について簡単な質問があります。私は自分のAPIのドキュメンテーションを作成するために新しいものを試したかったのです（そして、後でそれをテストします）。 APIはnode.jsで書かれています。

私のコード全体をapi.ramlファイルに含めるべきですか？または、他の.ramlファイルからサブルートをインポートすることは可能ですか？どのように.ramlファイルを分割するのによい指針がありますか？

books.ramlというファイルを作成したいと思います。それは/booksの下のすべてのルートを含むでしょう。その後、私はapi.ramlにインポートしたいので、サブファイルだけを含むファイルのようになります。

大丈夫ですか？はいの場合、私はどのようにこれを行うことができ、どのディレクトリにこのファイルをどこに保存するかに関するガイドラインは何ですか？

Answer 1

RAML仕様をいくつかのファイルに分割し、！includeディレクティブを使用してファイルをインクルードすることができます。例えば

：「RAMLライブラリは、データ型宣言、リソースタイプ宣言、形質宣言の任意のコレクションを組み合わせるために使用されています

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

についての詳細情報は、ライブラリが提供するRAMLほかhere

を含みセキュリティー・スキームの宣言をモジュール化された外部化された再利用可能なグループに変換する」

使用方法および使用方法は、使用方法によって異なります。しかし、私は図書館がより良い/より意味のある構造を提供できると思う。

modularizationについてのセクションを確認してください。

また、あなたのようなルートが

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

：例えば、言っているしかし、私はそれがあなたのRAMLを構造化する良い方法だか分からない含めることができます。