Menu
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?
750
Head over to Swagger Inspector, and insert the end point of the resource you want to have documented. You can then navigate to the right panel from the History section of Swagger Inspector, and click "Create API definition" to create the OAS definition.
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.
133
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
38
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
