.Net Core 使用swagger UI

本文转载自 muyeh 查看原文 2018-10-14 40 使用/ .net/ net

swagger UI

第一步：首先添加包Swashbuckle.AspNetCore （可通過微軟添加包命令Install-Package 包名進行添加，也可以通過管理NuGet程序包進行添加）

第二步：修改launchUrl為swagger，即程序啟動后進入swagger UI風格頁面也可以說Rest風格。

{
  "$schema": "http://json.schemastore.org/launchsettings.json",
  "iisSettings": {
    "windowsAuthentication": false, 
    "anonymousAuthentication": true, 
    "iisExpress": {
      "applicationUrl": "http://localhost:55360",
      "sslPort": 44347
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "WebApi": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "swagger",
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

launchSettings.json

第三步：在Startup.cs中的方法ConfigureServices方法中添加swagger 相關代碼。

   public voidConfigureServices(IServiceCollection services)
        {
         

            services.AddMvc();
            #region  添加SwaggerUI

            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Title = "dapper API接口文檔",
                    Version = "v1",
                    Description = "RESTful API for Dapper",
                    TermsOfService = "Z Terms Of Service",
                    Contact = new Contact { Name = "zhang", Email = "904086892@qq.com", Url = "" }
                });
            });
            #endregion
  }

ConfigureServices方法

第四步：在Startup.cs中的方法Configure方法中添加swagger 相關代碼。

 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {            
            if (env.IsDevelopment())
                app.UseDeveloperExceptionPage();
            else
                app.UseHsts();

            #region 使用SwaggerUI

            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "Dapper API V1");
            });

            #endregion
            app.UseHttpsRedirection();

            app.UseMvc();
        }

Configure方法

最后運行項目，可在該頁面下進行使用接口。效果如下：

注意！

本站转载的文章为个人学习借鉴使用，本站对版权不负任何法律责任。如果侵犯了您的隐私权益，请联系我们删除。

.net core 使用 swagger 生成接口文檔 .net core webapi 中使用Swagger .NET Core WEB API使用Swagger生成在線接口文檔 Asp.Net Core中使用Swagger，你不得不踩的坑記Asp.Net Core Swagger 使用並帶域接口處理 asp.net core swagger使用及注意事項 Asp.Net Core Api 使用Swagger管理文檔教程的安裝與使用 .NET Core和Swagger 生成 Api 文檔 .Net core 下Swagger如何隱藏接口的顯示 Swagger 在asp.net core中的應用2