Initially, we have to convert the file into bytes using File Class which is from System. We are returning a file here so, to make the client understand the content of the service, we have to modify the following HttpResponseMessage header properties.
We need to talk about the ContentType here. Complete Code in a single shot. In other words, no matter which of the four types you use, the client-side will not notice any difference when downloading a file from the API endpoint. Apart from the constructors for the four concrete types, we can use a method File , provided natively from the ControllerBase class, to return a concrete FileResult object.
With the groundwork laid, we can easily write an action method as follows:. In the code above, we first find or generate the requested file from the local file system or a file storage, then read the file content. In the end line 7 , we return a FileContentResult object that is created using the method File byte[] fileContents, string contentType, string fileDownloadName. Note that we should validate the request and user permissions before finding or generating the requested file.
And you can choose to stream the file too. In the File method line 7 , the second parameter contentType is used in the HTTP header to indicate the format of contents transmitted over the internet. You can set the value for contentType according to your file type. In the File method, the third parameter fileDownloadName determines the value for the filename attribute in the content-disposition HTTP response header. It's what's on the OpenAPI example website.
It works in SwaggerUI. It doesn't work with the c generated NSwag client. When using OpenApi v3, the first if block is used. So the difference must be with v2, operation. RicoSuter When do you think this could be fixed? Looks like a simple template fix, but I'm not sure what you're trying to do with the different flags. RicoSuter I wrote a test case for you:.
RicoSuter Do you think this will be addressed soon? I dont think its implemented soon as it is completely different than in swagger 2. I would love to have an example as well. My dotnet core API 3. It is sent via the generated typescript client. Before dotnet 3. I used an OperationFilter to get the working generated typescript client. I've tried a lot of different OperationFilter solutions to get the client to work. But my file always remain null. Looking forward to some help with this.
Post as a guest Name. Email Required, but never shown. The Overflow Blog. Who owns this outage? Building intelligent escalation chains for modern SRE. Podcast Who is building clouds for the independent developer? Featured on Meta. Now live: A fully responsive profile. Reducing the weight of our footer. Related Fill table ; this. Fill table ;. Datagridview c. Gmail DataGrid View. Functions you can call, Request parameters, response structure etc.
Some service simply give you WSDL as xml file you can download on local machine and then analyze or sometimes you may get direct URL e. Later we will see how to generate code for your desired programming language e.
You will learn more about this process in the later section. So Let's get started. Instead, it gives back only a subset of data and provides a mechanism for data pagination. Below you will find a few examples of API pagination. Sometimes errors occur Or can you? You may want to use them when your source is a resource located on the Internet; e.
0コメント