.net core 3.1 swagger配置

我会带着你远行 2022-12-20 11:29 142阅读 0赞

安装SwashBuckle.aspnetcore

Startup.cs

using System;  
using System.Collections.Generic;  
using System.IO;  
using System.Linq;  
using System.Threading.Tasks;  
using Microsoft.AspNetCore.Builder;  
using Microsoft.AspNetCore.Hosting;  
using Microsoft.AspNetCore.Mvc;  
using Microsoft.Extensions.Configuration;  
using Microsoft.Extensions.DependencyInjection;  
using Microsoft.Extensions.Hosting;  
using Microsoft.Extensions.Logging;  
using Microsoft.OpenApi.Models;

namespace WebApplication3  
\{  
public class Startup  
\{  
public Startup(IConfiguration configuration)  
\{  
Configuration = configuration;  
\}

public IConfiguration Configuration \{ get; \}

// This method gets called by the runtime. Use this method to add services to the container.  
public void ConfigureServices(IServiceCollection services)  
\{  
services.AddControllers();

services.AddSwagger(Configuration);

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.  
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)  
\{  
if (env.IsDevelopment())  
\{  
app.UseDeveloperExceptionPage();  
\}

var pathBase = string.Empty;// string.Empty;//Configuration\["PATH\_BASE"\];

//if (!string.IsNullOrEmpty(pathBase))  
//\{  
// loggerFactory.CreateLogger<Startup>().LogDebug("Using PATH BASE '\{pathBase\}'", pathBase);  
// app.UsePathBase(pathBase);  
//\}

app.UseSwagger()

.UseSwaggerUI(c =>  
\{  
c.SwaggerEndpoint($"\{ (!string.IsNullOrEmpty(pathBase) ? pathBase : string.Empty) \}/swagger/v1/swagger.json", "Catalog.API V1");  
\});

app.UseRouting();

app.UseAuthorization();

app.UseEndpoints(endpoints =>  
\{  
endpoints.MapControllers();  
\});  
\}  
\}

public static class CustomExtensionMethods  
\{  
public static IServiceCollection AddSwagger(this IServiceCollection services, IConfiguration configuration)  
\{  
services.AddSwaggerGen(options =>  
\{  
options.DescribeAllEnumsAsStrings();  
options.SwaggerDoc("v1", new OpenApiInfo  
\{  
Title = "eShopOnContainers - Catalog HTTP API",  
Version = "v1",  
Description = "The Catalog Microservice HTTP API. This is a Data-Driven/CRUD microservice sample"  
\});

//显示文档注释  
var basePath = @"d:\\WebApplication3\\";  
var xmlPath = Path.Combine(basePath, "SwaggerTest.xml");  
options.IncludeXmlComments(xmlPath);

\});

return services;

\}  
\}  
\}

LaunchSetting.json:

"WebApplication3": \{  
"commandName": "Project",  
"launchBrowser": true,  
"launchUrl": "swagger/index.html",  
"applicationUrl": "http://localhost:5000",  
"environmentVariables": \{  
"ASPNETCORE\_ENVIRONMENT": "Development"  
\}