swagger UI
第一步:首先添加包Swashbuckle.AspNetCore (可通过微软添加包命令Install-Package 包名进行添加,也可以通过管理NuGet程序包进行添加)
第二步:修改launchUrl为swagger,即程序启动后进入swagger UI风格页面也可以说Rest风格。
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
{ "$schema": "http://json.schemastore.org/launchsettings.json", "iisSettings": { "windowsAuthentication": false, "anonymousAuthentication": true, "iisExpress": { "applicationUrl": "http://localhost:55360", "sslPort": 44347 } }, "profiles": { "IIS Express": { "commandName": "IISExpress", "launchBrowser": true, "launchUrl": "swagger", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "WebApi": { "commandName": "Project", "launchBrowser": true, "launchUrl": "swagger", "applicationUrl": "https://localhost:5001;http://localhost:5000", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } }
第三步:在Startup.cs中的方法ConfigureServices方法中添加swagger 相关代码。
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
public voidConfigureServices(IServiceCollection services) { services.AddMvc(); #region 添加SwaggerUI services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { Title = "dapper API接口文档", Version = "v1", Description = "RESTful API for Dapper", TermsOfService = "Z Terms Of Service", Contact = new Contact { Name = "zhang", Email = "904086892@qq.com", Url = "" } }); }); #endregion }
第四步:在Startup.cs中的方法Configure方法中添加swagger 相关代码。
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) app.UseDeveloperExceptionPage(); else app.UseHsts(); #region 使用SwaggerUI app.UseSwagger(); app.UseSwaggerUI(options => { options.SwaggerEndpoint("/swagger/v1/swagger.json", "Dapper API V1"); }); #endregion app.UseHttpsRedirection(); app.UseMvc(); }
最后运行项目,可在该页面下进行使用接口。效果如下: