RAMLの文書pdf /バイナリ応答

Question

現在、システムに送信されたAccept-Headerに基づいてjsonまたはpdf（バイナリ）を返すAPIのドキュメントを作成しています。

レスポンスがバイナリまたは類似のタイプであるように指定するにはどうすればよいですか？

Answer 1

RAMLスペックでは、私が探していたようなtype: fileが見つかりました。 https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#file

Answer 2

以下のように応答を定義する必要があります。

また、可能なコンテンツタイプの列挙型でACCEPTヘッダーを指定することもできます。

 headers: 
     Accept: 
       type: string 
       enum: [application/octet-stream, application/json] 
      required: true