.Net Core WebApi(一)——添加Swagger


依賴項——右鍵——管理NuGet程序包——瀏覽——輸入以下內容

Install-Package Swashbuckle.AspNetCore -Pre

 

雙擊Properties——點擊生成——勾選XML文檔文件

 

雙擊Startup.cs——在ConfigureServices、Configure中添加以下內容:

ConfigureServices:

services.AddSwaggerGen(c =>
{
   c.SwaggerDoc("v1", new Info
   {
    Version = "v1",
    Title = "接口文檔",
    Description = "接口文檔",
    TermsOfService = "None",
   Contact = new Contact { Name = "唐少", Email = "tang14455@163.com", Url = "" }
   });
​
    //設置swagger json和ui的注釋路徑。
    var basePath = PlatformServices.Default.Application.ApplicationBasePath;
    var xmlPath = Path.Combine(basePath, "WebApi_Core.xml");//同XML文檔文件中名稱相同
    c.IncludeXmlComments(xmlPath);
    //  c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader參數
 });

 


 Configure:

         // 使中間件能夠將生成的Swagger作為JSON端點。
        app.UseSwagger();
        // 使中間件能夠服務swagger-ui(HTML,JS,CSS等),指定Swagger JSON端點。
        app.UseSwaggerUI(c =>
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "TwBusManagement API V1");
            c.ShowExtensions();
        });

 


 雙擊Properties下launchSettings.json——更改launchUrl中值為swagger(默認打開Swagger幫助頁):



 運行測試 



 


注意!

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



 
粤ICP备14056181号  © 2014-2021 ITdaan.com