2016-04-16 10 views
3

タイプを使用し、RAML 1.0を使用してAPIを書くときに、リクエストボディから1つ以上のプロパティを除外する方法はありますか?ボディタイプ(RAML)からプロパティを除外する方法はありますか?

説明します。私には、一連のプロパティを持つ「Order」という型があります。私はリソース/ordersとメソッドpostを持っているので、ユーザーは新しい注文を作成することができます。 リクエストボディは注文構造体jsonであり、レスポンスも注文構造体です。

しかし、ユーザーがリクエストを送信している間に注文IDを指定することは望ましくありません。しかし、そのID(とさらに2つの '応答のみ'フィールド)が応答で返されます。 OrderRequestのような余分なタイプを作成したくない場合は、Orderタイプで継承します。より洗練されたソリューションがありますか?

私は、リクエストの本文からいくつかのプロパティを除外し、その説明と例を使用するために他のプロパティを保持する方法が必要です。

おかげで、私の英語のため申し訳ありません:)

答えて

3

使用2種類。 2番目は最初の子です。例:

また、タイプの宣言にはLibraryを含めることができます。

1

継承を使用して余分な型を作成したくない場合でも、フィールドをオプションとしてマークし、それが応答に存在することを文書化できます。