How can I launch Swagger on the server?

Question

Hello,

I use Visual Studio Community 2022 (64 bit) Version 17.5.3.

I check the C# application by Visual Studio.

If I run debug(Press F5 key), Swagger launches(https://localhost:7173/swagger/index.html).

The application works on the server(Amazon EC2 instance).

I tried to access the URL 'https://(server domain)/swagger/index.html', but page is not found.

This application was created by the person who left office, and its specifications are unknown.

I heard that they could access the URL 'https://(server domain)/swagger/index.html' before.

It may be necessary to change the application setting, but no one know how to do it.

Could you tell me how can I launch Swagger on the server?

Thanks,

Answer 1

Hi, @pfdk , In Asp.Net Core, Swagger is default used in development environment, Check the below code in program.cs.

if (app.Environment.IsDevelopment())
{
      app.UseSwagger();
      app.UseSwaggerUI();
}

If you want to use swagger not only in development environment, You just need to delete the If() condition and use swagger middleware directly.

app.UseSwagger();     
app.UseSwaggerUI();

---

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Best regards,

Xinran Shen

Answer 2

Swagger is normally only available in development mode. Your server runs in release mode. If you want swagger to be available on your server, you need to change some code in the program.cs class and then build and redeploy the code to the server.

The code between the brackets should be moved outside the if {} block.

You do need to consider if you really want swagger to be available on the server, because if you can reach it, so can hackers, and hackers love to have this kind of information.

Answer 3

I'm sorry for my late reply. Thank you for your reply.

I have changed program.cs as you explained.

It works as I expected.

I'm afraid, I have one more question. How did you know the setting?