接口 Swagger 02 显示代码注释
原文:https://www.cnblogs.com/94pm/p/8046580.html
原文:https://www.cnblogs.com/lollipop/p/6651124.html
原文:https://www.cnblogs.com/landeanfen/p/5501487.html
准备工作:https://www.cnblogs.com/guxingy/p/12843876.html
一、Swagger Action 显示注释
1、在类HomeApiController.cs
中,跟代码添加注释,用于测试
2、项目编译时,生成文档注释
操作路径:项目上右键 -> 属性 -> 生成 -> 勾选
XML文档文件``
XML文档的默认输出路径:bin\WebApplication2.xml
3、让Swagger
读取XML文档
在SwaggerConfig.cs
这个文件中,取消这句代码的注释c.IncludeXmlComments(GetXmlCommentsPath());
在这个类SwaggerConfig.cs
中,添加如下方法:(此方法用于返回XML文档的路径)
public static string GetXmlCommentsPath()
{
string path = string.Format("{0}/bin/WebApplication2.xml", System.AppDomain.CurrentDomain.BaseDirectory);
return path;
}
二、Swagger Controller 显示注释
1、添加类SwaggerControllerDescProvider.cs
该类用于显示控制器的描述,但需要和js配置使用(注意)
代码如下:
/// <summary>
/// swagger显示控制器的描述,需要和js配置使用
/// 原文:https://www.cnblogs.com/94pm/p/8046580.html
/// </summary>
public class SwaggerControllerDescProvider : ISwaggerProvider
{
private readonly ISwaggerProvider _swaggerProvider;
private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>();
private readonly string _xml;
/// <summary>
///
/// </summary>
/// <param name="swaggerProvider"></param>
/// <param name="xml">xml文档路径</param>
public SwaggerControllerDescProvider(ISwaggerProvider swaggerProvider, string xml)
{
_swaggerProvider = swaggerProvider;
_xml = xml;
}
public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
{
var cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion);
SwaggerDocument srcDoc = null;
//只读取一次
if (!_cache.TryGetValue(cacheKey, out srcDoc))
{
srcDoc = _swaggerProvider.GetSwagger(rootUrl, apiVersion);
srcDoc.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } };
_cache.TryAdd(cacheKey, srcDoc);
}
return srcDoc;
}
/// <summary>
/// 从API文档中读取控制器描述
/// </summary>
/// <returns>所有控制器描述</returns>
public ConcurrentDictionary<string, string> GetControllerDesc()
{
string xmlpath = _xml;
ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();
if (File.Exists(xmlpath))
{
XmlDocument xmldoc = new XmlDocument();
xmldoc.Load(xmlpath);
string type = string.Empty, path = string.Empty, controllerName = string.Empty;
string[] arrPath;
int length = -1, cCount = "ApiController".Length;//因为之前的文章有修改路由,所以这里要变一下
XmlNode summaryNode = null;
foreach (XmlNode node in xmldoc.SelectNodes("//member"))
{
type = node.Attributes["name"].Value;
if (type.StartsWith("T:"))
{
//控制器
arrPath = type.Split('.');
length = arrPath.Length;
controllerName = arrPath[length - 1];
if (controllerName.EndsWith("Controller"))
{
//获取控制器注释
summaryNode = node.SelectSingleNode("summary");
string key = controllerName.Remove(controllerName.Length - cCount, cCount);
if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
{
controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
}
}
}
}
}
return controllerDescDict;
}
}
2、修改SwaggerConfig.cs
文件
在SwaggerConfig.cs
这个文件中,取消代码注释,代码如下
c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));
将该代码修改为:
c.CustomProvider((defaultProvider) => new App_Start.SwaggerControllerDescProvider(defaultProvider,GetXmlCommentsPath()));
这个功能需要js配合才行,js的配置在下面
三、Swagger 汉化 和 Controller的注释显示(主要是js的配合)
1、添加JS文件
在Scripts
文件夹中,添加js文件swagger_lang.js
,然后在js文件上,右键选择属性,生成操作项 选择 嵌入的资源
js的内容如下:
'use strict';
window.SwaggerTranslator = {
_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 () {
try {
console.log($("#input_baseUrl").val());
$.ajax({
type: "get",
async: true,
url: $("#input_baseUrl").val(),
dataType: "json",
success: function (data) {
var summaryDict = data.ControllerDesc;
console.log(summaryDict);
var id, controllerName, strSummary;
$("#resources_container .resource").each(function (i, item) {
id = $(item).attr("id");
if (id) {
controllerName = id.substring(9);
try {
strSummary = summaryDict[controllerName];
if (strSummary) {
$(item).children(".heading").children(".options").first().prepend('<li class="controller-summary" style="color:green;" title="' + strSummary + '">' + strSummary + '</li>');
}
} catch (e) {
console.log(e);
}
}
});
}
});
} catch (e) {
console.log(e);
}
},
_tryTranslate: function (word) {
return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;
},
learn: function (wordsMap) {
this._words = wordsMap;
}
};
/* jshint quotmark: double */
window.SwaggerTranslator.learn({
"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 () {
window.SwaggerTranslator.translate();
window.SwaggerTranslator.setControllerSummary();
});
2、取消注释
在WebApiConfig.cs
中,取消这句代码的注释
c.InjectJavaScript(thisAssembly, "Swashbuckle.Dummy.SwaggerExtensions.testScript1.js");
将这句代码修改为:
c.InjectJavaScript(thisAssembly, "WebApplication2.Scripts.swagger_lang.js");
注意:这里的js路径为逻辑路径
。
三、效果展示
注释包含了几个部分:参数model的注释,返回model的注释等等,仔细一下界面就能发现
相关文章
- 定制并发类(七)实现ThreadFactory接口生成自定义的线程给Fork/Join框架
- C#与Java对比学习:类型判断、类与接口继承、代码规范与编码习惯、常量定义
- (一)DepthAI-python相关接口:OAK Device
- Java动态代理代码案例:使用jdk自带的Proxy只能对有接口的类进行动态代理
- 表格存储新手指南:Java SDK异步接口的使用
- Atitit stomp.js conn连接activemq 目录 1.1. activemq 启动,已经默认开启了stomp ws的接口。。地址是1 1.2. Js 客户端代码1 1.3
- Atitit 提升水平 把代码写的有技术含量 目录 1. 提高可读性(重要)2 1.1. 异常模式代替返回值2 1.2. Dsl2 1.3. 流畅接口方法链2 1.4. 层次结构抽象2 1
- 发现 postman 自动生成接口调用代码的一个问题
- android 11.0 添加自定义系统服务接口给app调用
- 蓝牙4.0 传统蓝牙 低功耗 API接口 BLE系统架构 GPA 和 GATT
- 【一天一门编程语言】用 Go 语言实现一个 DAG 任务调度系统的API 接口代码
- 【Groovy】闭包 Closure ( 闭包调用 与 call 方法关联 | 接口中定义 call() 方法 | 类中定义 call() 方法 | 代码示例 )
- 接口也是一种合约(严肃脸)
- 游戏测试中,这几个接口测试知识点不能忽略
- java中请给一个Abstract类实现接口的实例!
- 自研开源项目(3)基于pytest和数据驱动的自定义接口自动化框架caterpillar_apitest
- C/C++编程操作Redis数据库,hiredis包装redis数据库操作接口及测试(增删改查与连接)
- 华为防火墙如何配置双出口,特定IP段流量走指定出接口地址上网