How to secure generated API documentation using swagger swashbuckle

Question

I have implemented API documentation using swagger swashbukle. Now I want to publish generated documentation as a help file in my website. How to secure this link and publish?

score 2 · Accepted Answer · answered Aug 29 '16 at 18:47

2

I don't think there's a way to secure the swagger swashbuckle endpoint up until now. You can have tips and more into this from their github issue here

answered Aug 29 '16 at 18:47

Swagata Prateek

1,076
7
15

1

Thanks for the issue link. Below given solution works for me. https://github.com/domaindrivendev/Swashbuckle/issues/384#issuecomment-111609097 – Priyanka Mane Aug 30 '16 at 06:40

score 2 · Answer 2 · edited Aug 30 '16 at 07:14

This solution will only work if you have implemented authentication in your solution.

Create new folder swagger in solution
Add new Web.config file.

write following code in it:

<configuration> 
    <system.web> 
        <authorization> 
            <deny users="?" /> 
        </authorization> 
    </system.web> 
    <system.webServer> 
        <modules runAllManagedModulesForAllRequests="true" /> 
    </system.webServer> 
</configuration>

score 0 · Answer 3 · edited Jun 27 '19 at 10:24

I figured out the way to do this. Use the latest swashbuckle version and add the below div tag in the injected index.html

<div id='auth_container'></div>

This will show an Authorize button in the swagger UI which can be used for authentication and once Authenticated, for all the requests to the API, the JWT token will be passed from the swagger UI

Also, follow the below link to protect all the calls for the swagger docs - https://github.com/domaindrivendev/Swashbuckle/issues/601

How to secure generated API documentation using swagger swashbuckle

3 Answers3

Linked