.net core 添加 Swagger


1.新建一個Core項目

  添加nuget包:Swashbuckle.AspNetCore

  添加Startup文件:

    先引用:

using Swashbuckle.AspNetCore.Swagger;

    添加的配置如下:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
            });
        }


        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {//啟用中間件服務生成Swagger作為JSON終結點
            app.UseSwagger();
            //啟用中間件服務對swagger-ui,指定Swagger JSON終結點
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });
        }

   這樣就可以打開swagger調試接口了  https://localhost:44399/swagger/index.html

 

2.swagger顯示接口xml注釋

  右鍵屬性    生成   輸出   XML文檔文件  打勾

  配置

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
                // 為 Swagger JSON and UI設置xml文檔注釋路徑
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程序所在目錄(絕對,不受工作目錄影響,建議采用此方法獲取路徑)
                var xmlPath = Path.Combine(basePath, "MySwagger.xml");//和項目名對應
                c.IncludeXmlComments(xmlPath);
            });
        }

效果圖: 

    

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM