如何使用Swagger Swashbuckle保护生成的API文档

Question

我使用Swagger Swashbuckle实现了API文档。现在我想将生成的文档作为帮助文件发布在我的网站上。如何保护此链接并进行发布？

- Priyanka Mane

Answer 1

我认为目前还没有一种方法可以保护Swagger Swashbuckle端点。你可以在他们的GitHub问题中获得更多提示和信息这里

- Swagata Prateek

---

感谢提供问题链接。下面给出的解决方案对我有效。https://github.com/domaindrivendev/Swashbuckle/issues/384#issuecomment-111609097 - Priyanka Mane

Answer 2

如果您的解决方案已经实现了身份验证，那么这个解决方案才会起作用。

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

3. write following code in it:

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

- Priyanka Mane

Answer 3

我找到了解决方法。使用最新的Swashbuckle版本并在注入的index.html中添加以下div标签： <div id='auth_container'></div> 这将在Swagger UI中显示一个“授权”按钮，可用于身份验证。一旦通过身份验证，对于所有API请求，JWT令牌将从Swagger UI传递。

此外，请按照以下链接保护Swagger文档的所有调用- https://github.com/domaindrivendev/Swashbuckle/issues/601

- Silly John