Swagger not working on Azure Web app running as OWIN

Question

I have a ASP.NET Web API implemented as OWIN middleware. I hosted it on azure and now I have a problem using swagger. It is perfectly working on localhost but when I try it on azure I get this:

The way I did my configuration for swagger on the API was to completely remove SwaggerConfig.cs file and add all the configuration into my Startup.cs class as shown here: How to generate documentation using swashbuckle for WebApi 2 with Owin . If it is going to help, I am trying to implement oAuth2 between my API, identity server and client application.

Can you help me find out what is the reason for not getting swagger functionality on Azure?

EDIT: I also tried the solution from here but without success. I went to my API->Properties->Buld tab->Changed to 'Release' configuration->In the output path added the same what was in the 'Debug' configuration and nothing.

My bin folder on Azure:

Do you require authentication to view the swagger ui? and can you browse to ../swagger/docs/v1? — VisualBean, Sep 09 '16 at 08:49
No, there's no such requirement. When I run it on localhost there's no such thing as authorization. Right after I navigate to swagger/ui/index it gives me the controllers, methods etc. — user2128702, Sep 09 '16 at 08:51
try setting - then browse to swagger/docs/v1 and look at the error — VisualBean, Sep 09 '16 at 09:00
I get exactly the same error. No matter if I have this set in my Web.config or not. — user2128702, Sep 09 '16 at 09:04
have you checked if the xml file is in the azure web server? use elmah to log the error, this is probably that swagger can't find the xml to generate the docs, user the server explorer Tab in VS to check for the file — General Electric, Sep 10 '16 at 04:04
@JGEstevez Yes, I can see it in the server explorer. It is there in the bin folder and has xml metadata inside of it. — user2128702, Sep 10 '16 at 08:06

score 0 · Answer 1 · answered Sep 27 '16 at 20:53

I had this problem myself when going though this tutorial.

In that tutorial on #3 under "Configure the middle tier to call the data tier" I named my key apiAppURL instead of toDoListDataAPIURL. This caused me to get 500 response codes and

{
  "Message": "An error has occurred."
}

in the response body.

I fixed it by updating the following line:

var client = new ApiApp(new Uri(ConfigurationManager.AppSettings["toDoListApiURL"]));

to

var client = new ApiApp(new Uri(ConfigurationManager.AppSettings["apiAppURL"]));

**The change made was to the string at the end of the line. That code can be found in ToDoListController.cs on line 42

Hope this helps someone!

score 0 · Answer 2 · answered Mar 18 '17 at 15:52

Check your SwaggerConfig.cs file, if you are not included the xml file with your swagger, it works in your azure app services.

c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\WebApiSwagger.XML");
c.DescribeAllEnumsAsStrings();

I've included these 2 lines of code to show my xml in the swagger, the azure swagger will gone error.

score 0 · Answer 3 · answered Apr 05 '18 at 13:11

This is late reply but may help someone in future. I solved this issue this way:

Set XML documentation file path in project settings to : wwwroot\api.xml

Let Swagger know where the file is within ConfigureServices method in Startup.cs:

        services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });

        // Set the comments path for the Swagger JSON and UI.
        var xmlFile = "api.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, "wwwroot", xmlFile);
        c.IncludeXmlComments(xmlPath);
    });

You can set different paths but you will get the idea of how to do it from this example.

Swagger not working on Azure Web app running as OWIN

3 Answers3

Linked