Skip to main content

How to set Swagger as the default start page for API hosted on the Azure web app?

I created an Asp.Net Core 2.x Web API and configured Swagger on it, below is the code added in Configure method under Startup.cs file, for full swagger configuration, check here

//Add swagger configuration
app.UseSwagger();

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("../swagger/v1/swagger.json", "Test API V1");
});

On my local machine when I run the API it is automatically redirected to the Swagger page.

However, when I hosted this API as an Azure web app it is not redirecting directly to the Swagger and to access the swagger, I had to append /swagger in the URL, for example, https://testapi.azurewebsites.net/swagger/

Solution:

Set RoutePrefix to string.Empty under app.UseSwaggerUI like below:

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("../swagger/v1/swagger.json", "Test API V1");
    c.RoutePrefix = string.Empty;// Set Swagger UI at apps root
});

And that’s it, now when you browse the Azure web app, it’ll automatically redirect you to the Swagger page.



Comments

Popular posts from this blog

Error 405 : ASP.NET Core Web API PUT and DELETE Methods not allowed

Recently, while working with .Net core API I came across the issue of “Error 405 — Methods not Allowed” After some research, I found out that both GET and POST requests working fine but neither PUT nor DELETE requests working. Another thing is that the PUT and DELETE request was also working fine on my local machine but failed when we host on our Azure server. When I explored the issue on the web it led me to the conclusion that WebDAVModule seems to set PUT and DELETE request methods disabled by default and due to that PUT and DELETE throw 405 errors. To make the PUT and DELETE requests work, we need to override the WebDAVModule setting in web.config file by adding the below settings under “ system.webServer ”. < system.webServer >   < modules runAllManagedModulesForAllRequests = " false " >     < remove name = " WebDAVModule " />   </ modules > </ system.webServer > There may be 2 web.config files in your

C#: Merging Excel cells with NPOI HSSFWorkbook

In this post we’ll see how to merge the two or more cell with each other while creating the excel sheet using NPOI . Mentioned below is code to merge multiple cells, in this example we are merging first cell to fifth cell of first row (you can adjust row or cell range by passing particular parameters in CellRangeAddress). //Created new Workbook var hwb = new NPOI.HSSF.UserModel. HSSFWorkbook (); //Create worksheet with name. var sheet = hwb.CreateSheet( "new sheet" ); //Create row and cell. var row = sheet.CreateRow(0); var cell = row.CreateCell(0); ; //Set text inside cell cell.SetCellValue( "This is Merged cell" ); cell.CellStyle.WrapText = true ; //define cell range address // parameters: -> first row to last and first cell to last cell var cra = new NPOI.SS.Util. CellRangeAddress (0, 0, 0, 4); //Add merged region to sheet. sheet.AddMergedRegion(cra); Hope this solution helps you J

ASP.Net: Export to HTML file and save with save file dialog in C#.

So continuing from my exporting sample series here I am narrating how to export data to HTML file in C#, ASP.Net. For this example I’ll use same “ GetData ” method (to get the data for exporting) which we had used in Export to Excel example, you can use your own method to get data. /// <summary> /// Export to Html /// </summary> public static void ExportHtmlFile() {     const string format = "<tr><td>{0}</td><td>{1}</td><td>{2}</td><td>{3}</td></tr>" ;     var sb = new StringBuilder ();     sb.AppendFormat( "<h1 style='font-size: 18px;font-weight: bold;'>{0}</h1>"         , "Export HTML Sample" );     sb.Append( "<table style='width:500px;'>" );     sb.AppendFormat(format         , "First Name"         , "Last Name"         , "Email Address"