.Net Core 使用swagger UI

.Net Core 使用swagger UI

swagger入门

本文为极简主义，万事从简，勿喷。

swagger简介
swagger确实是个好东西，可以跟据业务代码自动生成相关的api接口文档，尤其用于restful风格中的项目，开发人员几乎可以不用专门去维护rest api，这个框架可以自动为你的业务代码生成restfut风格的api，而且还提供相应的测试界面，自动显示json格式的响应。大大方便了后台开发人员与前端的沟通与联调成本。

第一步，首先nuget添加swagger包，如下图所示。

第二步，修改appsetting文件，lanchurl为swagger

  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchUrl": "swagger",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "https://localhost:5001;http://localhost:5000"
    },
    "DotNetCore.Practice.Web": {
      "commandName": "Project",
      "launchUrl": "swagger",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "https://localhost:5001;http://localhost:5000"
    },

第三步，在Startup.cs中的方法ConfigureServices方法以及Configure方法中添加swagger 相关代码。
ps：偷个懒，极简主义，不是必须的一律不写。

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

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

      app.UseRouting();
      app.UseSwagger();
      app.UseSwaggerUI(c =>
      {
          c.SwaggerEndpoint("/swagger/v1/swagger.json", "API Demo v1");
      });
      app.UseEndpoints(endpoints =>
      {
           endpoints.MapControllers();
      });
   }

最后运行项目，可在该页面下进行使用接口（自行编写）。效果如下：

PS：我是青春代码，山高路远，江湖再见。 友情提示：创作不易，转载请注明出处。