【swagger】C#中swagger的使用及避坑|江阴雨辰互联

2023年6月20日发(作者：)

【swagger】C#中swagger的使⽤及避坑@⽬录开发 web api 的时候，写⽂档是个痛苦的事情，⽽没有⽂档别⼈就不知道怎么调⽤，所以⼜不得不写。swagger 可以⾃动⽣成接⼝⽂档，并测试接⼝，极⼤的解放了程序员的⽣产⼒。1 安装通过 NuGet 安装 Swashbuckle。安装完成后，App_Start ⽂件夹下会多出⼀个⽂件。重新⽣成并发布 api，打开⽹页 host）⽹页显⽰如下：2 修改名称和版本号上图中框出的名称和版本号是可以修改的，打开⽂件，找到如下代码：ApiVersion("v1", "");修改其中的参数，重新发布即可。3 显⽰说明swagger 可以读取代码中的注释，并显⽰在⽹页上。如此⼀来，我们只需要在代码中将注释写好，就可以⽣成⼀份可供他⼈阅读的 API ⽂档了。swagger 是通过编译时⽣成的 xml ⽂件来读取注释的。这个 xml ⽂件默认是不⽣成的，所以先要修改配置。第⼀步：右键项⽬ -> 属性 -> ⽣成，把 XML ⽂档⽂件勾上。第⼆步：添加配置在⽂件中添加配置如下：uration .EnableSwagger(c => { ApiVersion("v2", "测试 API 接⼝⽂档"); // 配置 xml ⽂件路径 eXmlComments($@"{rectory}"); })注意：发布的时候，XML ⽂件不会⼀起发布，需要⼿动拷到发布⽬录下。4 显⽰控制器注释及汉化默认是不会显⽰控制器注释的，需要⾃⼰写。在 App_Start 中新建类

SwaggerControllerDescProvider，代码如下：///

/// swagger 显⽰控制器的描述///

public class SwaggerCacheProvider : ISwaggerProvider{ private readonly ISwaggerProvider _swaggerProvider; private static ConcurrentDictionary _cache = new ConcurrentDictionary(); private readonly string _xmlPath; ///

///

/// /// xml⽂档路径 public SwaggerCacheProvider(ISwaggerProvider swaggerProvider, string xmlpath) { _swaggerProvider = swaggerProvider; _xmlPath = xmlpath; } public SwaggerDocument GetSwagger(string rootUrl, string apiVersion) { var cacheKey = ("{0}_{1}", rootUrl, apiVersion); //只读取⼀次 if (!_Value(cacheKey, out SwaggerDocument srcDoc)) { srcDoc = _gger(rootUrl, apiVersion); Extensions = new Dictionary { { "ControllerDesc", GetControllerDesc() } }; _(cacheKey, srcDoc); } return srcDoc; } ///

/// 从API⽂档中读取控制器描述 ///

/// 所有控制器描述 public ConcurrentDictionary GetControllerDesc() { ConcurrentDictionary controllerDescDict = new ConcurrentDictionary(); if ((_xmlPath)) { XmlDocument xmldoc = new XmlDocument(); (_xmlPath); string[] arrPath; int cCount = "Controller".Length; foreach (XmlNode node in Nodes("//member")) { string type = utes["name"].Value; if (With("T:")) { arrPath = ('.'); string controllerName = arrPath[ - 1]; if (th("Controller")) //控制器 { //获取控制器注释 XmlNode summaryNode = SingleNode("summary"); string key = ( - cCount, cCount); if (summaryNode != null && !OrEmpty(ext) && !nsKey(key)) { (key, ()); } } } } } return controllerDescDict; }}另外，新建⽂件并将其设置成嵌⼊的资源，这个⽂件的作⽤就是显⽰控制器注释及汉化。js 代码如下：'use strict';rTranslator = { _words: [], translate: function () { var $this = this; $('[data-sw-translate]').each(function () { $(this).html($this._tryTranslate($(this).html())); $(this).val($this._tryTranslate($(this).val())); $(this).attr('title', $this._tryTranslate($(this).attr('title'))); }); }, setControllerSummary: function () { $.ajax({ type: "get", async: true, url: $("#input_baseUrl").val(), dataType: "json", success: function (data) { var summaryDict = llerDesc; var id, controllerName, strSummary; $("#resources_container .resource").each(function (i, item) { id = $(item).attr("id"); if (id) { controllerName = ing(9); strSummary = summaryDict[controllerName]; if (strSummary) { $(item).children(".heading").children(".options").first().prepend('

' + strSummary + '

'); } } }); } }); }, _tryTranslate: function (word) { return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word; }, learn: function (wordsMap) { this._words = wordsMap; }};/* jshint quotmark: double */({ "Warning: Deprecated": "警告：已过时", "Implementation Notes": "实现备注", "Response Class": "响应类", "Status": "状态", "Parameters": "参数", "Parameter": "参数", "Value": "值", "Description": "描述", "Parameter Type": "参数类型", "Data Type": "数据类型", "Response Messages": "响应消息", "HTTP Status Code": "HTTP 状态码", "Reason": "原因", "Response Model": "响应模型", "Request URL": "请求 URL", "Response Body": "响应体", "Response Code": "响应码", "Response Headers": "响应头", "Hide Response": "隐藏响应", "Headers": "头", "Try it out!": "试⼀下！", "Show/Hide": "显⽰/隐藏", "List Operations": "显⽰操作", "Expand Operations": "展开操作", "Raw": "原始", "can't parse JSON. Raw result": "⽆法解析 JSON。原始结果", "Model Schema": "模型架构", "Model": "模型", "apply": "应⽤", "Username": "⽤户名", "Password": "密码", "Terms of service": "服务条款", "Created by": "创建者", "See more at": "查看更多：", "Contact the developer": "联系开发者", "api version": "api 版本", "Response Content Type": "响应 Content Type", "fetching resource": "正在获取资源", "fetching resource list": "正在获取资源列表", "Explore": "浏览", "Show Swagger Petstore Example Apis": "显⽰ Swagger Petstore ⽰例 Apis", "Can't read from server. It may not have the appropriate access-control-origin settings.": "⽆法从服务器读取。可能没有正确设置 access-control-origin。", "Please specify the protocol for": "请指定协议：", "Can't read swagger JSON from": "⽆法读取 swagger JSON于", "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染 Swagger UI", "Unable to read api": "⽆法读取 api", "from path": "从路径", "server returned": "服务器返回"});$(function () { ate(); trollerSummary();});在添加如下配置：uration .EnableSwagger(c => { Provider((defaultProvider) => new SwaggerCacheProvider(defaultProvider, $@"{rectory}")); }) .EnableSwaggerUi(c => { JavaScript(cutingAssembly(), "");

});5 路由相同，查询参数不同的⽅法在实际的 Web API 中，是可以存在路由相同，HTTP ⽅法相同，查询参数不同的⽅法的，但不好意思，swagger 中不⽀持，并且会直接报错。如下代码，[Route("api/users")]public IEnumerable Get(){ return users;}[Route("api/users")]public IEnumerable Get(int sex){ return users;}报错： Multiple operations with path 'api/users' and method 'GET'.可以在添加如下配置：uration .EnableSwagger(c => { eConflictingActions(apiDescriptions => ()); })此配置的意思是，当遇到此种情况时，取第⼀个⽅法展⽰。这可以避免报错，但多个⽅法只会在 swagger 中展⽰⼀个。治标不治本，不推荐。所以唯⼀的解决⽅案就是设置成不同的路由。不知道这个问题在之后的版本中会不会修复。6 忽略 Model 中的某些字段如下图，新建⽤户时，后台需要⼀个 User 类作为参数。点击右侧的

Model，可以显⽰ User 类的属性及注释。但是，有些字段其实是⽆需调⽤者传递的。例如

State，调⽤者⽆需知道这些字段的存在。给这些属性标记上

[nore] 特性，swagger 中不再显⽰了。当然这种做法也是有缺点的，因为 web api 在返回数据时，调⽤的默认序列化⽅法也是序列化。7 传递 header调⽤ api 时，有些信息是放在 HTTP Header 中的，例如

token。这个 swagger 也是⽀持的。新建⼀个特性：public class ApiAuthorizeAttribute : Attribute{}新建⼀个类代码如下：public class AuthorityHttpHeaderFilter : IOperationFilter{ public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) { if (ters == null) ters = new List(); //判断是否添加权限过滤器 var isAuthorized = tomAttributes().Any(); if (isAuthorized) { (new Parameter { name = "token", @in = "header", description = "令牌", required = false, type = "string" }); } }}这段代码就是告诉 swagger，如果遇到的⽅法上标记了

ApiAuthorizeAttribute 特性，则添加⼀个名为

token 的参数在

header 中。最后需要在中注册这个过滤器。uration .EnableSwagger(c => { ionFilter(); })效果如下：8 出错时的 HTTP 状态码我们在⽅法中返回⼀个 400[Route("api/users")]public HttpResponseMessage Post([FromBody]User user){ return new HttpResponseMessage() { Content = new StringContent("新建⽤户出错", 8, "application/json"), StatusCode = uest };}可是，swagger 中返回的状态码却是 0。这是因为

Content 指定了 JSON 格式，但传⼊的

content ⼜不是 JSON 格式的。将

content 改为 JSON 格式，或者将

mediaType 改成

text/plain 就可以了。

发布者：admin，转转请注明出处：http://www.yc00.com/xiaochengxu/1687250570a54.html