在RAML中记录pdf /二进制响应

Question

我目前正在编写api的文档，该文档根据发送到系统的Accept-Header返回json或pdf（二进制）。

如何指定响应是二进制或类似的类型？

Answer 1

在RAML规范中，我发现protected $primaryKey = 'ID'; public function getIDAttribute() { return Crypt::encrypt($this->attributes['ID']); } 似乎是我正在寻找的东西。见https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#file

Answer 2

您需要定义可能的响应，如下所示。

  responses:
    200:
      body:
        application/octet-stream:
        .......
        application/json:
        ........

此外，您还可以使用可能的内容类型的枚举指定ACCEPT标头。

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