How to specify that a pdf is returned in swagger?

swagger swagger-ui swagger-2.0 swagger-editor
Scottingham picture Scottingham · Aug 24, 2015 · Viewed 14.8k times · Source

I have a get call in my swagger REST API that needs to return a pdf file. There is no clear example / documentation on how to do this without causing a syntax error.

  responses:
    200:
      description: Returns PDF
      schema: [application/pdf]

and 

  responses:
    200:
      description: Returns PDF
      schema: 
        type: file

and

  responses:
    200:
      description: Returns PDF
      schema:
        type:  [application/pdf]

all fail. Is this even possible?

Answer

Ron picture Ron · Aug 25, 2015 
  responses:
    200:
      description: Returns PDF
      schema: 
        type: file

Out of the options you gave, that's the right option. Also, make sure to use produces: [application/pdf]

If it fails for you, make sure you use the latest version of the editor. There was a bug related to the file type that was recently resolved.

Related questions

Following swagger specifications, how can I define json of nested objects to yaml?

I am having a problem in defining the array of objects in swagger yaml. Swagger editor is giving an error everytime I try to define the type: array part of the yaml. I defined it, but it is not right …

Read More
How to define Swagger 2.0 JSON to populate default body parameter object in Swagger UI?

Our current deployment patterns require me to manually write my swagger json output that will be consumed by the Swagger-based UI in use at my company. I'd like the json I'm writing to provide 'default' values to populate the Swagger …

Read More
How do you define an array of different examples in a Swagger spec?

I'm trying to document an API with a static swagger file that can return some JSON that contains an array that looks something like this: [ { "type": "type A", "field A": "this field is specific to type A" }, { "type": "type B", "…

Read More