.Net Core WebApi 之 Swagger 注释

问题：

　　上一篇文章我们已经可以通过Swagger生成的Web页面对WebApi进行测试。先希望WebApi的具体方法有对应的注释。

解决：

1：在StartUp.cs 中添加以下代码：

  public void ConfigureServices(IServiceCollection services)
        { 
            services.AddControllers();

            // 注册Swagger服务
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "My Demo API",
                    Version = "v1.0",
                    Description = "My Demo API"
                }
                );
                c.SwaggerDoc("v2", new OpenApiInfo
                {
                    Version = "v1.0",
                    Title = "基础接口",
                    Description = "用户登录认证接口"
                });

                // 为 Swagger 设置xml文档注释路径
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器层注释，true表示显示控制器注释
                c.IncludeXmlComments(xmlPath, true);
            });

        }

View Code