Hamazon.Swagger.Ui

C# Code from Swashbuckle.AspNetCore.SwaggerUI . Ui Code from https://github.com/jensoleg/swagger-ui

本项目基于Swashbuckle.AspNetCore.SwaggerUI 更改而来,

使用界面比较好看的 https://github.com/jensoleg/swagger-ui.

在UI库上增加了部分语言切换和过时接口标识.

fork地址:https://github.com/hemiaoio/swagger-ui

UI示例:Auth0 api explorer

参照Swashbuckle.AspNetCore.SwaggerUI

使用方式:

1.安装Swashbuckle.AspNetCore 相关包

Install-Package Swashbuckle.AspNetCore.Swagger
Install-Package Swashbuckle.AspNetCore.SwaggerGen
Install-Package Hamazon.AspNetCore.SwaggerUI

2.添加Swagger Service Web Startup.cs

...
        public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            ...
            //MVC
            services.AddMvc(options =>
            {
                options.Filters.Add(new CorsAuthorizationFilterFactory(DefaultCorsPolicyName));
            }).AddJsonOptions(options => {
                //options.SerializerSettings.ContractResolver = new NullToEmptyResolver();
            });
            ...
            //Swagger - Enable this line and the related lines in Configure method to enable swagger UI
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info { Title = "Demo API", Version = "v1" });
                options.DescribeAllEnumsAsStrings();
                options.DocInclusionPredicate((docName, description) => true);
                options.DocumentFilter<DynamicApiDocumentFilter>(); //定义controller名称
            });
            services.ConfigureSwaggerGen(c => {
                var xmlFilePaths = new List<string>() {
                    "Demo.WebApi.xml",
                    "Demo.Web.xml"
                    ...
                    //添加自己需要显示注释的的XML
                };
                foreach(var filePath in xmlFilePaths) {
                    var xmlFilePath = Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, filePath);
                    if(File.Exists(xmlFilePath)) {
                        // 新版 Swashbuckle.AspNetCore.SwaggerGen 内置了 Controller 描述加载功能，默认为 false,这里手动指定为true即可
                        c.IncludeXmlComments(xmlFilePath,true);
                    }
                }
            });
            ...
        }
...

         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            ...
            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "defaultWithArea",
                    template: "{area}/{controller=Home}/{action=Index}/{id?}");

                routes.MapRoute(
                    name: "default",
                    template: "{controller=Home}/{action=Index}/{id?}");
            });

            // Enable middleware to serve generated Swagger as a JSON endpoint
            app.UseSwagger(options => {
            });
            // Enable middleware to serve swagger-ui assets (HTML, JS, CSS etc.)
            app.UseHSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "Demo API V1");
                options.InjectOnCompleteJavaScript("lang/zh-cn.js");  //语言文件
                options.InjectOnCompleteJavaScript("js/swagger.translator.js"); //语言切换
            }); //URL: /swagger
        }
...

3.语言切换(如果需要) swagger.translator.js

(function() {
    var i = 0;
    function promise(callback) {
        if(i >= JSConfig.OnCompleteScripts.length) {
            callback();
            return;
        }
        var script = JSConfig.OnCompleteScripts[i];
        if(script === "js/swagger.translator.js") {
            callback();
        } else {
            $.getScript(script).success(function() {
                i++;
                promise(callback);
            });
        }
    };
    promise(function() {
        if(window.SwaggerTranslator) {
            window.SwaggerTranslator.translate();
        }
    });
})();