欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

在.NetCore Api 中使用 Swagger

程序员文章站 2024-01-27 14:13:46
...

一、新建.netCore webapi项目

在.NetCore Api 中使用 Swagger

二、安装swagger ,通过 Package Manager 控制台:Install-Package SwashBuckle.AspNetCore -Pre

在.NetCore Api 中使用 Swagger

三、修改Startup.cs 

      public void ConfigureServices(IServiceCollection services)
        {
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "Demo Api"
                });
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                var xmlPath = Path.Combine(basePath, "CoreApi.xml");
                c.IncludeXmlComments(xmlPath);
            });

        }

     public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreApi Docs");
            });
            app.UseMvc();
        }

四、修改项目属性,生成xml文档

在.NetCore Api 中使用 Swagger

五、launchsettings.json文件,设置启动页。

  "$schema": "http://json.schemastore.org/launchsettings.json",

  "profiles": {

    "IIS Express": {

      "commandName": "IISExpress",

      "launchBrowser": true,

      "launchUrl": "swagger",

      "environmentVariables": {

        "ASPNETCORE_ENVIRONMENT": "Development"

      }

    }

  }

在.NetCore Api 中使用 Swagger

 六、效果

在.NetCore Api 中使用 Swagger