c# swagger

搭建方法

1.新建的web项目带有webapi

2.Nuget包新增Swagger

   1、安装完Swashbuckle后，nuget会将相关引用添加至项目，App_Start文件夹下会添加一个SwaggerConfig.cs文件，如图所示：

 2、可以在上述文件设置swagger的显示版本和页面标题

 c.SingleApiVersion("v1", "测试");

 3.修改Global.asax类

AreaRegistration.RegisterAllAreas();
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
GlobalConfiguration.Configure(WebApiConfig.Register);//添加

访问http://localhost:56321/swagger/ui/index（这里按照自己的项目启动端口更改） 即可看到所有API的文档说明。界面如图所示：

4、 打开xml文档文件 相关工程生成XML文档

右键项目属性—>生成—>勾选XML文档文件

 

 

 界面显示

 5、汉化 SwaggerUI 

在Scripts增加swagger.js

'use strict';  
  
/** 
 * Translator for documentation pages. 
 * 
 * To enable translation you should include one of language-files in your index.html 
 * after <script src='lang/translator.js' type='text/javascript'></script>. 
 * For example - <script src='lang/ru.js' type='text/javascript'></script> 
 * 
 * If you wish to translate some new texsts you should do two things: 
 * 1. Add a new phrase pair ("New Phrase": "New Translation") into your language file (for example lang/ru.js). It will be great if you add it in other language files too. 
 * 2. Mark that text it templates this way <anyHtmlTag data-sw-translate>New Phrase</anyHtmlTag> or <anyHtmlTag data-sw-translate value='New Phrase'/>. 
 * The main thing here is attribute data-sw-translate. Only inner html, title-attribute and value-attribute are going to translate. 
 * 
 */  
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')));  
        });  
    },  
  
    _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();  
});

注：右键点击该js文件修改属性为嵌入的资源

 修改 SwaggerConfig文件：修改如下

 

界面如下显示

 

相关工程需要生成XML文档

二、.NET 5

.Net5 WebApi Swagger配置（1）添加注释

控制器怎么显示汉字注释