19

リクエストとレスポンスのモデルを定義したい。私は AWS でサーバーレス フレームワークを使用しています。

README には、この行を含める必要があると書かれていますcustom.documentation.models.MODELNAME

schema: ${file(models/error.json)}

しかし、ベースラインとして使用するサンプル ファイルはありませんmodels/error.json

実際のserverless.ymlの例では、次のような定義があります。

-
  name: DoSomethingRequest
  contentType: "application/json"
  schema:
    type: array
    items:
      type: string

これは、私がやろうとしていることについて十分な詳細を提供していません。


私の目標は、文字列オブジェクト、メッセージ、およびステータス コードの配列に対してスキーマを定義することです。ただし、メッセージとステータス コードはオプションです。これらは他のモデルの一部である可能性もあります。可能であれば、モデルごとに定義を繰り返したくありません。

私の現在の試みは:

-
  name: ReturnArrayResponse
  contentType: "application/json"
  schema:
    type: array
    itemsArray:
      type: string
    message:
      type: string
    statusCode:
      type: number

これで自分のやりたいことが実現すると思いますが、他のモデルでこれら 2 つの項目をオプションとして繰り返すにはどうすればmessageよいstatusCodeでしょうか?

serverless.yml ファイルに入れることができる yml ソリューションか、参照できる json ファイルのいずれかに満足しています。

4

2 に答える 2