zoukankan      html  css  js  c++  java
  • .NET Core Api 集成 swagger

    废话不多讲

    第一步  当然是要通过 NuGet 安装第三方插件 swagger

      程序包管理器控制台,安装命令:Install-Package Swashbuckle.AspNetCore -Pre

    第二步 在Startup 文件中添加配置:

      1. ConfigureServices 方法:

            public void ConfigureServices(IServiceCollection services)
            {
                services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
    
                services.AddMvc().AddJsonOptions(options =>
                    options.SerializerSettings.ContractResolver =
                        new Newtonsoft.Json.Serialization.DefaultContractResolver());
    
                services.AddSwaggerGen();
                services.ConfigureSwaggerGen(options =>
                {
                    options.SwaggerDoc("v1", new Info
                    {
                        Version = "v1",
                        Title = "MsSystem API"
                    });
    
                    options.IncludeXmlComments(Path.Combine(".\bin\netcoreapp2.1\", "ApiDemo.xml"));
                    options.DescribeAllEnumsAsStrings();
                });
            }
    

      2. Configure 方法

            public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
            {
                loggerFactory.AddConsole(Configuration.GetSection("Logging"));
                loggerFactory.AddDebug();
    
                if (env.IsDevelopment())
                {
                    app.UseDeveloperExceptionPage();
                }
                else
                {
                    app.UseHsts();
                }
    
                app.UseHttpsRedirection();
                //app.UseMvc();
                app.UseMvc(routes =>
                {
                    routes.MapRoute(
                        name: "areas",
                        template: "{area:exists}/{controller=Home}/{action=Index}/{id?}"
                    );
                });
    
                app.UseSwagger();
                app.UseSwaggerUI(c =>
                {
                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "MsSystem API V1");
                });
            }
    

    第三步  设置输出地址

    第四步  修改配置文件

    最后 Ctrl+F5  如果出现以下界面,说明配置成功。

  • 相关阅读:
    HIVE优化学习笔记
    HIVE执行引擎TEZ学习以及实际使用
    端口状态 LISTENING、ESTABLISHED、TIME_WAIT及CLOSE_WAIT详解,以及三次握手四次挥手,滑动窗口(整理转发)
    kafka时间轮简易实现(二)
    kafka时间轮的原理(一)
    JAVA之G1垃圾回收器
    JAVA之垃圾收集器
    JAVA之内存结构
    SparkSQL学习笔记
    Python 学习 --简单购物车程序
  • 原文地址:https://www.cnblogs.com/teng-0802/p/9399652.html
Copyright © 2011-2022 走看看