Swagger download file endpoint

Each operation must have at least one response defined, usually a successful response. JSON is the most common format for data exchange, but not the only one possible. To specify the response media types, use the content keyword at the operation level.

An operation typically returns one successful status code and one or more error statuses. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. Each response status requires a description. For example, you can describe the conditions for error responses. Markdown CommonMark can be used for rich text representation. Melu Melu 1, 3 3 gold badges 12 12 silver badges 12 12 bronze badges.

Save the JSON as swagger. Sign up or log in Sign up using Google. Sign up using Facebook. Sign up using Email and Password. Post as a guest Name. Email Required, but never shown. The Overflow Blog. Podcast An oral history of Stack Overflow — told by its founding team. Millinery on the Stack: Join us for Winter Summer? Bash, ! Featured on Meta. New responsive Activity page. Linked See more linked questions.

Related 1. The Swagger UI generates a file input field array which allows us to add or remove files before sending the request. The problem is not in the Swashbuckle. AspNetCore library but an issue in an upstream library, swagger-ui issue We can test it using Postman, like the screenshot below. The API endpoint is functioning as expected. For now, we need to wait for the swagger-ui team to fix the issue if we want to upload an array of files using the Swagger user interface.

Another common scenario is submitting a form with some form entries and an attachment. For example, a student chooses a form and uploads a file in the web page.

Then, we set the SubmitForm action method to take a FormData object from the request body using the [FromForm] attribute. The code snippet below shows an example implementation. The generated Swagger UI looks like the following screenshot. We can fill out the route parameters and the FormData parameters, and upload a file in the user interface. The following screenshot shows an example response body and response header.

For one, looks very hack-ish because the producer is ignored. Also, you cannot defer f. Close in the handler, because the middleware executes after you return. That forces me to take ownership of the file in the mw and close it there. The text was updated successfully, but these errors were encountered:. Writer which in turn is a bit more appropriate. You'd still need the responder you wrote though. Sorry, something went wrong.

I tried using string and format binary. Why do I get an io. Writer as a result on the client? There is a fix I made for this but I put it in a wip branch, I'll put it on master this weekend.

You will still get a writer back though because presumably you want to save the files somewhere and don't want to hold the entire thing in memory. The generated code takes care of draining the response body reader with the writer.