其他分享
首页 > 其他分享> > Swagger生成webapi文档

Swagger生成webapi文档

作者：互联网

WebApi接口开发完毕后，交付给前端人员或手机端开发者时接口说明文档是必不可少的配套设备，如果公司流程不规范大家使用口口相传的交接方式，而且没有改进的欲望，那你可以到此为止了。Swagger是方便测试接口，快速展示注释内容，生成Restful风格接口文档的框架。

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
Swagger 有一个强大的社区，里面有许多强悍的贡献者。

1、安装Swashbuckle

2、初次运行 输入 自己网站地址/swagger 我这里是http://www.permissionapi.com/swagger

3、添加自定义ApiController

  1. public class AdminController : ApiController
  2.     {
  3.         /// <summary>
  4.         /// 获取管理员信息
  5.         /// </summary>
  6.         /// <param name="username">管理员姓名</param>
  7.         /// <param name="pwd">管理员密码</param>
  8.         /// <returns></returns>
  9.         public string Get(string username,string pwd)
  10.         {
  11.             return $"username:{username},pwd:{pwd}";
  12.         }
  13.     }

 

4、添加实现了ISwaggerProvider接口的类

在App_Start文件夹中添加SwaggerControllerDescProvider.cs，相关代码如下：

  1. namespace WebApiSwagger.Main.App_Start
  2. {
  3.     /// <summary>
  4.     /// 显示swagger控制器的描述
  5.     /// </summary>
  6.     public class SwaggerControllerDescProvider : ISwaggerProvider
  7.     {
  8.         private readonly ISwaggerProvider _swaggerProvider;
  9.         private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>();
  10.         private readonly string _xml;
  11.         /// <summary>
  12.         /// 
  13.         /// </summary>
  14.         /// <param name="swaggerProvider"></param>
  15.         /// <param name="xml">xml文档路径</param>
  16.         public SwaggerControllerDescProvider(ISwaggerProvider swaggerProvider, string xml)
  17.         {
  18.             _swaggerProvider = swaggerProvider;
  19.             _xml = xml;
  20.         }
  21.  
  22.         public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
  23.         {
  24.  
  25.             var cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion);
  26.             SwaggerDocument srcDoc = null;
  27.             //只读取一次
  28.             if (!_cache.TryGetValue(cacheKey, out srcDoc))
  29.             {
  30.                 srcDoc = _swaggerProvider.GetSwagger(rootUrl, apiVersion);
  31.  
  32.                 srcDoc.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } };
  33.                 _cache.TryAdd(cacheKey, srcDoc);
  34.             }
  35.             return srcDoc;
  36.         }
  37.  
  38.         /// <summary>
  39.         /// 从API文档中读取控制器描述
  40.         /// </summary>
  41.         /// <returns>所有控制器描述</returns>
  42.         public ConcurrentDictionary<string, string> GetControllerDesc()
  43.         {
  44.             string xmlpath = _xml;
  45.             ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();
  46.             if (File.Exists(xmlpath))
  47.             {
  48.                 XmlDocument xmldoc = new XmlDocument();
  49.                 xmldoc.Load(xmlpath);
  50.                 string type = string.Empty, path = string.Empty, controllerName = string.Empty;
  51.  
  52.                 string[] arrPath;
  53.                 int length = -1, cCount = "Controller".Length;
  54.                 XmlNode summaryNode = null;
  55.                 foreach (XmlNode node in xmldoc.SelectNodes("//member"))
  56.                 {
  57.                     type = node.Attributes["name"].Value;
  58.                     if (type.StartsWith("T:"))
  59.                     {
  60.                         //控制器
  61.                         arrPath = type.Split('.');
  62.                         length = arrPath.Length;
  63.                         controllerName = arrPath[length - 1];
  64.                         if (controllerName.EndsWith("Controller"))
  65.                         {
  66.                             //获取控制器注释
  67.                             summaryNode = node.SelectSingleNode("summary");
  68.                             string key = controllerName.Remove(controllerName.Length - cCount, cCount);
  69.                             if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
  70.                             {
  71.                                 controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
  72.                             }
  73.                         }
  74.                     }
  75.                 }
  76.             }
  77.             return controllerDescDict;
  78.         }
  79.     }
  80. }

5、添加功能性js文件

在Scripts文件夹中添加SwaggerConfig.js脚本文件，将其设置为“嵌入的资源”。这个js文件的功能主要有两个：一个是汉化，另一个是在界面上显示控制器的描述文字。

代码如下：

  1. 'use strict';
  2. window.SwaggerTranslator = {
  3.     _words: [],
  4.  
  5.     translate: function () {
  6.         var $this = this;
  7.         $('[data-sw-translate]').each(function () {
  8.             $(this).html($this._tryTranslate($(this).html()));
  9.             $(this).val($this._tryTranslate($(this).val()));
  10.             $(this).attr('title', $this._tryTranslate($(this).attr('title')));
  11.         });
  12.     },
  13.  
  14.     setControllerSummary: function () {
  15.         $.ajax({
  16.             type: "get",
  17.             async: true,
  18.             url: $("#input_baseUrl").val(),
  19.             dataType: "json",
  20.             success: function (data) {
  21.                 var summaryDict = data.ControllerDesc;
  22.                 var id, controllerName, strSummary;
  23.                 $("#resources_container .resource").each(function (i, item) {
  24.                     id = $(item).attr("id");
  25.                     if (id) {
  26.                         controllerName = id.substring(9);
  27.                         strSummary = summaryDict[controllerName];
  28.                         if (strSummary) {
  29.                             $(item).children(".heading").children(".options").first().prepend('<li class="controller-summary" title="' + strSummary + '">' + strSummary + '</li>');
  30.                         }
  31.                     }
  32.                 });
  33.             }
  34.         });
  35.     },
  36.     _tryTranslate: function (word) {
  37.         return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;
  38.     },
  39.  
  40.     learn: function (wordsMap) {
  41.         this._words = wordsMap;
  42.     }
  43. };
  44.  
  45.  
  46. /* jshint quotmark: double */
  47. window.SwaggerTranslator.learn({
  48.     "Warning: Deprecated": "警告：已过时",
  49.     "Implementation Notes": "实现备注",
  50.     "Response Class": "响应类",
  51.     "Status": "状态",
  52.     "Parameters": "参数",
  53.     "Parameter": "参数",
  54.     "Value": "值",
  55.     "Description": "描述",
  56.     "Parameter Type": "参数类型",
  57.     "Data Type": "数据类型",
  58.     "Response Messages": "响应消息",
  59.     "HTTP Status Code": "HTTP状态码",
  60.     "Reason": "原因",
  61.     "Response Model": "响应模型",
  62.     "Request URL": "请求URL",
  63.     "Response Body": "响应体",
  64.     "Response Code": "响应码",
  65.     "Response Headers": "响应头",
  66.     "Hide Response": "隐藏响应",
  67.     "Headers": "头",
  68.     "Try it out!": "试一下！",
  69.     "Show/Hide": "显示/隐藏",
  70.     "List Operations": "显示操作",
  71.     "Expand Operations": "展开操作",
  72.     "Raw": "原始",
  73.     "can't parse JSON.  Raw result": "无法解析JSON. 原始结果",
  74.     "Model Schema": "模型架构",
  75.     "Model": "模型",
  76.     "apply": "应用",
  77.     "Username": "用户名",
  78.     "Password": "密码",
  79.     "Terms of service": "服务条款",
  80.     "Created by": "创建者",
  81.     "See more at": "查看更多：",
  82.     "Contact the developer": "联系开发者",
  83.     "api version": "api版本",
  84.     "Response Content Type": "响应Content Type",
  85.     "fetching resource": "正在获取资源",
  86.     "fetching resource list": "正在获取资源列表",
  87.     "Explore": "浏览",
  88.     "Show Swagger Petstore Example Apis": "显示 Swagger Petstore 示例 Apis",
  89.     "Can't read from server.  It may not have the appropriate access-control-origin settings.": "无法从服务器读取。可能没有正确设置access-control-origin。",
  90.     "Please specify the protocol for": "请指定协议：",
  91.     "Can't read swagger JSON from": "无法读取swagger JSON于",
  92.     "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染Swagger UI",
  93.     "Unable to read api": "无法读取api",
  94.     "from path": "从路径",
  95.     "server returned": "服务器返回"
  96. });
  97. $(function () {
  98.     window.SwaggerTranslator.translate();
  99.     window.SwaggerTranslator.setControllerSummary();
  100. });

6、修改SwaggerConfig.cs

Swagger安装完毕后App_Start文件夹下才会有SwaggerConfig.cs文件，修改后的SwaggerConfig.cs的代码如下：

注意代码中 JiaHua.Permission.Api是项目名称,请改成自己项目对应的名称！

  1. public class SwaggerConfig
  2. {
  3.     public static void Register()
  4.     {
  5.         var thisAssembly = typeof(SwaggerConfig).Assembly;
  6.  
  7.         GlobalConfiguration.Configuration
  8.             .EnableSwagger(c =>
  9.                 {
  10.                     c.SingleApiVersion("v1", "JiaHua.Permission.Api");
  11.                     //添加下述代码                        
  12.                     var xmlFile = string.Format("{0}/bin/JiaHua.Permission.Api.XML", System.AppDomain.CurrentDomain.BaseDirectory);
  13.                     if (System.IO.File.Exists(xmlFile))
  14.                     {
  15.                         c.IncludeXmlComments(xmlFile);
  16.                     }
  17.                     c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
  18.                     c.CustomProvider((defaultProvider) => new SwaggerControllerDescProvider(defaultProvider, xmlFile));
  19.                 })
  20.             .EnableSwaggerUi(b => 
  21.                 {
  22.                     b.InjectJavaScript(Assembly.GetExecutingAssembly(), "JiaHua.Permission.Api.Scripts.SwaggerConfig.js");
  23.                 });
  24.     }
  25. }

7、修改项目的“XML文档文件”属性

右键项目--》属性--》生成

8、注释显示成功

9、小瑕疵及解决方法

 

み旋律 发布了20 篇原创文章 · 获赞 0 · 访问量 777 私信 关注

标签：webapi,function,string,public,文档,controllerName,Swagger,Response
来源： https://blog.csdn.net/weixin_44481764/article/details/104503075