Core3.0使用Swagger接口文檔

本文轉載自查看原文 2020-06-02 15:16 1545 06 .NetCore

前言

此方法為百度搜索結果，原文鏈接找不到了

步驟

1.引用Nuget

Swashbuckle.AspNetCore

2.Startup.cs配置

            //注冊swagger服務,定義1個或者多個swagger文檔
            services.AddSwaggerGen(s =>
            {
                //設置swagger文檔相關信息
                s.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "NoteWebApi文檔",
                    Description = "Note隨記備忘錄接口文檔",
                    Version = "v1.0"
                });

                //獲取xml注釋文件的目錄
                var xmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = System.IO.Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 啟用xml注釋
                s.IncludeXmlComments(xmlPath);
            });

            //啟用swagger中間件
            app.UseSwagger();
            //啟用SwaggerUI中間件（htlm css js等），定義swagger json 入口
            app.UseSwaggerUI(s =>
            {
                s.SwaggerEndpoint("/swagger/v1/swagger.json", "NoteWebapi文檔v1");
                //要在應用的根 (http://localhost:&lt;port&gt;/) 處提供 Swagger UI，請將 RoutePrefix 屬性設置為空字符串：
                //s.RoutePrefix = string.Empty;
            });