.net core 使用swagger接口描述

首先安装nuget包

Swashbuckle.AspNetCore.Swagger

Swashbuckle.AspNetCore.SwaggerGen

Swashbuckle.AspNetCore.SwaggerUI

1.在configureServices中 加入 swagger注册代码

    public void ConfigureServices(IServiceCollection services)
         {
             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
 
             services.AddSwaggerGen(c =>
             {
                 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.XML";
                 var xmlPath1 = System.IO.Path.Combine(AppContext.BaseDirectory, $"{xmlFile}");
 
                 var xmlModelPath1 = System.IO.Path.Combine(AppContext.BaseDirectory, $"ClassLibrary1.xml");
                 c.IncludeXmlComments(xmlPath1);
                 c.IncludeXmlComments(xmlModelPath1);
 
                 c.SwaggerDoc("v1", new Swashbuckle.AspNetCore.Swagger.Info
                 {
                     Title = "test", //根据项目修改
                     Version = "V1",
                     Contact = new Swashbuckle.AspNetCore.Swagger.Contact
                     {
                         Name = "test",
                         Email = "234242@qq.com",
                         Url = "https://www.test.com"
                     },
                     License = new License
                     {
                         Name = "内部授权",
                         Url = "https://www.test.com"
                     }
                 });
             });
         }

ConfigureServices

2.在configure中  使用 swagger中间件

   public void Configure(IApplicationBuilder app, IHostingEnvironment env)
         {
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();
             }
 
             app.UseMvc();
             //启用中间件服务生成Swagger作为JSON终结点
             app.UseSwagger();
             //启用中间件服务对swagger-ui，指定Swagger JSON终结点
             app.UseSwaggerUI(c =>     //引用 Swashbuckle.AspNetCore.SwaggerUI
             {
                 c.SwaggerEndpoint("../swagger/v1/swagger.json", "O2O Order API");//SMS App API  根据内容修改
             });
         }

Configure

为web项目及VModel项目生成XML文档

在接口上使用特性ProducesResponseType ，用以描述返回值信息。

启动·项目 进入http://localhost:54022/swagger/index.html

IP port 改成你项目对应的ip 和 port

点开刚才设置的post接口  即可查看到  参数和返回值信息了