core 中使用 swagger-优快云博客

本文详细介绍了如何在ASP.NET Core项目中配置并使用Swagger，实现RESTful API的文档自动生成与在线测试。通过代码示例展示了如何设置兼容版本、添加Swagger文档、配置UI界面等关键步骤。

引包

代码

public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            
            //help
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "接口文档",
                    Description = "RESTful API for Hicard",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "-", Email = "-", Url = "" }
                });

                //Set the comments path for the swagger json and ui.
                c.IncludeXmlComments(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Doc.xml")); //文档路径

                //  c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数
            });
        }

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

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

文档生成需要在项目属性里设置