.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='width: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漢化頁面效果