NET 5.0 Swagger API 自动生成MarkDown文档

主要接口
///
/// ISwaggerDocGenerator
///
public interface ISwaggerDocGenerator
{
///
/// 获取Swagger流文件
///
///
///
Task GetSwaggerDocStreamAsync(string name);
///
/// 获取Swagger MarkDown源代码
///
///
///
string GetSwaggerDoc(string name);
}
2、Startup配置
注册SwaggerDoc服务
services.AddSwaggerDoc();//（用于MarkDown生成）
注册Swagger服务
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v1”, new OpenApiInfo { Title = “Swagger API 示例文档”, Version = “v1”,Description=“API文档全部由代码自动生成” });
c.IncludeXmlComments(“Samples.xml”);
});
引用Swagger中间件
app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", “Samples v1”));
3、生成MarkDown
///
/// SwaggerController
///
[ApiController]
public class SwaggerController : ControllerBase
{
///
/// API文档导出
///
[HttpGet("/doc")]
public async Task Doc([FromServices] ISwaggerDocGenerator swaggerDocGenerator, [FromServices] IWebHostEnvironment environment)
{
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
var stream = await swaggerDocGenerator.GetSwaggerDocStreamAsync(“v1”);
stopwatch.Stop();
var log = “Swagger文档导出成功，耗时” + stopwatch.ElapsedMilliseconds + “ms”;
Debug.WriteLine(log);
var mime = “application/octet-stream”;
var name = “SwaggerDoc.md”;
return File(stream.ToArray(), mime, name);
}
}
USB Microphone https://www.soft-voice.com/
Wooden Speakers https://www.zeshuiplatform.com/
亚马逊测评 www.yisuping.cn
深圳网站建设www.sz886.com