引入 Nuget 包
- Swashbuckle.AspNetCore.SwaggerGen
- Swashbuckle.AspNetCore.SwaggerUI
配置 Startup
配置 ConfigureServices
- services.AddSwaggerGen(c =>
- {
- c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
- {
- Version = "v1",
- Title = ApiName
- });
- c.OrderActionsBy(a => a.RelativePath);
- var xmlFile = "WikiServer.xml";// 文件名来源于项目属性 ==》生成 ==》输出 ==》xml 文档文件
- var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
- // 启用 xml 注释. 该方法第二个参数启用控制器的注释, 默认为 false.
- c.IncludeXmlComments(xmlPath, true);
- });
配置 Configure
- App.UseSwagger();
- App.UseSwaggerUI(c => {
- c.SwaggerEndpoint($"/swagger/v1/swagger.json", $"{ApiName} V1");
- // 路径配置, 设置为空, 表示直接在根域名 (localhost:8001) 访问该文件, 注意 localhost:8001/swagger 是访问不到的, 去 launchSettings.JSON 把 launchUrl 去掉, 如果你想换一个路径, 直接写名字即可, 比如直接写 c.RoutePrefix = "doc";
- c.RoutePrefix = "";
- });
来源: http://www.bubuko.com/infodetail-3424396.html