Skip to main content
 首页 » 编程设计

c#之使用 swagger 的 Web API 文档

2024年05月29日47落叶无声

我是 swagger 的新手,我看过几个在线文档来将 Swagger 实现到我的 webapi 并使用 SwaggerConfig 的一些属性进行自定义。

这是我的要求:- 我需要根据“API_Key”TextBox 的值仅在“Explore”按钮单击时显示 swagger 文档,该值应与我的 app.config 键匹配。

所以我看到这样实现:-

  1. 用户来到我的 swagger 主页,默认情况下它会有空文档,除了图像中显示的标题。
  2. 在标题中提供的文本框中输入 API_Key,然后点击“探索”。
  3. 输入的 API key 使用我的 app.config 中的 key 进行验证,或者如果可能,在 SwaggerConfig 中进行验证。
  4. 如果验证显示文档,否则将错误消息显示为无效的 API key 。

需要建议。

亲切的问候, 拉古

请您参考如下方法:

只需编辑 index.html 并在 addApiKeyAuthorization 更改事件中添加您需要的 header 。在这里查看更多信息:

https://github.com/swagger-api/swagger-ui#header-parameters