c#在MVC Api(.net framework)当中使用Swagger,以及Demo下载

Demo下载地址。

主要的步骤就是创建项目,通过nuget 添加Swashbuckle包,然后在SwaggerConfig当中进行相关的配置。

 

具体的步骤,可以参考下面的链接:

  1. https://www.cnblogs.com/94pm/p/8046580.html
  2. https://blog.csdn.net/xiaouncle/article/details/83995809
  3. https://www.cnblogs.com/dawenyang/p/10911051.html

根据需要,这里面添加了一些扩展。

 其中2和3的部分是为了界面汉化和显示控制器说明。

 

1的部分是为了支持隐藏一些不需要暴露出来的控制器或者方法。具体怎么使用HiddenApi,请参考我写的两个控制器Demo

 

如下图所示,TestAPI20控制器(Controller)有2个 动作(Action),其中Test21可以正常出现在Swagger界面上,

 而Test10因为上面标记的HiddenApi,而被隐藏。

 

Demo下载地址 

 -------------------------------------

备注两个特别的文章 :

一、让Swagger支持token

《【swagger】C# 中 swagger 的使用及避坑》

https://www.cnblogs.com/gl1573/p/12652708.html

二、解决跨方案(solution)、跨类库的注释问题

《swagger使用二:swagger配置多个项目注释》

https://www.cnblogs.com/eastday/p/6382613.html

posted @ 2023-08-28 16:17  柳城之城  阅读(291)  评论(0编辑  收藏  举报