Swagger is used to describe the REST web api. For regular XML base WCF application the web service can be discovered using wsdl which is not applicable for RESTful web api. Here Swagger come into picture. It help to understand what is the end point exposed by the web api, what kind of input, output format it use. In this Tutorial you will see how to customize Swagger UI in asp.net web api.
Required tools used for this sample application
- Windows 10
- MS Visual Studio Community Edition 2019
- dotnet core 3.1[LTS]
- Swashbuckle.AspNetCore version 6.2.3
Create a dotnet core Web api application
 |
| VS 2019 create project |
 |
| Add project Name |
 |
| Additional Project Info |
Add dotnet core package reference for Swashbuckle.AspNetCore -Version 6.2.3
 |
| Add Swagger Nuget Package |
Add Swagger generator to Startup.cs. In some cases you can add to program.cs. In that case use builder object to add to Swagger generator middleware.
 |
| Add Swagger Gen |
Add the swagger based upon running environment config. It is not necessary to use only for Development config. It can be used for any other runtime environment configuration also.
 |
| Add Swagger based upon env config |
Here we are done with basic setup for Swagger for dotnet core web api. If you run the application from Visual Studio, you should be able to view below screen.
 |
| Swagger api documentation |
Now we see how we can add some more customization to the Swagger UI.
Set the Router prefix to null so that it can render to root of the api
