.net core swagger汉化

基本swagger使用不再详解，具体百度其它帖子

1.将汉化的swagger js文件复制到项目根目录中

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": "服务器返回"
});
window.saveToken=function() {
    var test_token = $("#customtoken").val();
    localStorage.setItem("test_x_token", $("#customtoken").val());
    $("input[name='X-Token']").val(test_token)
}

$(function () {
    window.SwaggerTranslator.translate();
    //token保存
    var test_token = localStorage.getItem("test_x_token")||"";
    $(".authorize-wrapper").append("X-Token：<input type='text' id='customtoken' value='" + test_token +"' style='50%' /> <button onClick='saveToken()'>保存</button>")
    $("input[name='X-Token']").val(test_token)
    $("input[name='X-Version']").val(swaggerUi.api.info.version)
    
});

2.将汉化js文件注入到中间件中

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory, IServiceProvider svp) {
           　#region API文档中间件
            app.UseSwagger(c => {
                c.PreSerializeFilters.Add((swagger, httpReq) => swagger.Host = httpReq.Host.Value);
                
            });
            app.UseSwaggerUi(c => {
                
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Travel.Api v1.0.0");
                c.ShowRequestHeaders();
                c.ShowJsonEditor();
                //注入汉化文件
                c.InjectOnCompleteJavaScript($"/swagger_translator.js");
            });
            #endregion

            app.UseMvc();
        }

3.添加Controller汉化标签,在项目中添加一个swagger扩展类SwaggerExtensions

代码如下：

 /// <summary>
    /// 添加控制器swagger扩展类
    /// </summary>
    public class ApplyTagDescriptions : IDocumentFilter {
        /// <summary>
        /// swagger汉化标签
        /// </summary>
        /// <param name="swaggerDoc"></param>
        /// <param name="context"></param>
        public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context) {
            swaggerDoc.Tags = new List<Tag>
            {
                new Tag { Name = "Enterprise", Description = "企业相关接口" },
                new Tag { Name = "Ticket", Description = "机票相关接口" }
            };
        }
    }

通过IDocumentFilter接口去生成控制器的标签(描述)

options.CustomSchemaIds(type => type.FullName); // 可以解决相同类名会报错的问题

代码如下：

#region API文档注入服务
            services.AddSwaggerGen(options => {
                options.SwaggerDoc("v1",
                    new Info {
                        Title = "Travel.Api",
                        Version = "v1",
                        Description = "",
                        TermsOfService = "None",
                        Contact = new Contact {
                            Name = "",
                            Email = "",
                            Url = "https://www.cnblogs.com/wsprince/"
                        },

                    }

                );

                options.CustomSchemaIds(type => type.FullName); // 解决相同类名会报错的问题
                //API接口文件路径
                var filePath = Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, "Travel.Api.Controllers.xml");
                options.IncludeXmlComments(filePath);
                //请求实体路径
                var requestfilePath = Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, "Travel.Api.DTO.xml");
                options.IncludeXmlComments(requestfilePath);
                options.DescribeAllEnumsAsStrings();
                //添加对控制器的标签(描述)
                options.DocumentFilter<ApplyTagDescriptions>();
            });
            #endregion

　　

4.swagger汉化页面效果