Published on: 27 October, 2017

How to download a file using .Net Web API MVC ?

Posted by andy | 220 views 0 likes 0 favourites 0 comments
Tumblr Digg Google Plus

In this article, you will learn how to download a file in Web API MVC. We will use HTTP Get API method to perform this download action with one single parameter which will accept the file name. Here is the full code.

//import namespaces
using System.IO;
using System.Net.Http.Headers;

[HttpGet]
public HttpResponseMessage DownloadFile(string fileName)
{
	if (!string.IsNullOrEmpty(fileName))
	{
		string filePath = "/images/";
		string fullPath = AppDomain.CurrentDomain.BaseDirectory + filePath + "/" + fileName;
		if (File.Exists(fullPath))
		{

			HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
			var fileStream = new FileStream(fullPath, FileMode.Open);
			response.Content = new StreamContent(fileStream);
			response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
			response.Content.Headers.ContentDisposition.FileName = fileName;
			response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
			return response;
		}
	}

	return new HttpResponseMessage(HttpStatusCode.NotFound);
}

So how does the code work? Basically, the API will accept a query string which is the file name. We can get the root path of our project by using the following code.

AppDomain.CurrentDomain.BaseDirectory

What we need to do next is to make sure if the user has passed the file name in the query string and if they are, we then check using System.IO.File to see if the file exists on the server. To test it, you can just need to call the API path in your HTML code. See example below and change the API path accordingly as this is just an example only.

<a href='/APIPath/DownloadFile?fileName=ImageName.jpg'>Download file</a>
Comments

There are no comments available.

Write Comment
0 characters entered. Maximum characters allowed are 1000 characters.
Share your article with us and add your own google adsense account to earn extra money. Plus, you can promote a link back to your site.
Related Articles
Published on: 28 October, 2016

In this tutorial you will learn how easily you can implement a simple checkout express using C# MVC Web API. We will create a really simple shopping cart where customers can add and delete their cart items before proceed to payment.