How to specify that a pdf is returned in swagger?

Question

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?

score 24 · Accepted Answer · answered Aug 25 '15 at 06:42

24

  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.

answered Aug 25 '15 at 06:42

Ron

14,160
3
52
39

5

With Open API 3.0 , try below `responses: '200': description: A PDF file content: application/pdf: schema: type: string format: binary` Documentation: https://swagger.io/docs/specification/describing-responses/ Section:Response That Returns a File – nitashathakur Feb 20 '20 at 00:58
2

@dev1918 you should post it as another answer. – Innokenty Sep 02 '21 at 14:32

score 22 · Answer 2 · answered Oct 17 '21 at 20:32

With Open API 3.0 ,try below responses:

get:
  summary: Returns the report in the PDF format
  responses:
    '200':
      description: A PDF file
      content:
        application/pdf:
          schema:
            type: string
            format: binary

Documentation: swagger.io/docs/specification/describing-responses

Section: Response That Returns a File

How to specify that a pdf is returned in swagger?

2 Answers2