【大道至簡】NetCore3.1快速開發框架一：集成Swagger

在上一章節中，咱們建立了基本的框架結構：http://www.javashuo.com/article/p-rbpletsr-mm.html

下面咱們測試接口和集成Swagger接口文檔

 

1、接口測試

在默認建立的API中，大大和2.2不同的是給了一個默認的接口示例，但不是Values了，變成了一個天氣預報，【爲何呢~~~】

 

好吧，無論是Values仍是天氣預報，只要能運行起來，就是好大大

在Api項目右擊，點擊選擇運行，或者在工具欄，點擊運行-啓動而不調試

 

自動會打開瀏覽器，運行成功

 

 下一步，咱們本身新建的接口測試一下

在API項目中，Controller文件夾，右擊新建文件

 

選擇ASP.NET Core ——Web Api控制器類，輸入一個本身寫的名字，點擊新建按鈕

 

 這樣一個簡單的接口測試類就生成了

 

 生成項目F6

輸入測試地址：https://localhost:5001/api/values    訪問成功

 2、集成Swagger接口文檔

在FytSoa.Api項目右擊依賴項中，選擇管理nuget包，並搜索Swashbuckle.AspNetCore包添加至引用 

 

 添加成功

 

 

在 Startup 類中 添加並配置 Swagger 中間件

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

在 Startup.Configure 方法中，啓用中間件爲生成的 JSON 文檔和 Swagger UI 提供服務

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

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

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }

生成FytSoa.Api項目並運行

輸入網址：https://localhost:5001/swagger/index.html

接口文檔集成成功

 附上微軟地址：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio-mac

 

 下一章：集成Nlog日誌管理