SwaggerDoc
SwaggerDoc 是基于 Swashbuckle.AspNetCore 类库的离线文档生工具。文档以 JSON 结构描述参数说明,支持枚举类型描述。工具导出 Markdown 格式文件,可以根据自己需求再将 Markdown 文件转换为自己所需要的文件格式。
如何使用?
dotnet add package SwaggerDoc --version 1.0.1
services.AddSwaggerDoc(); //(用于MarkDown生成)
注册 Swagger 服务
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo {Title = "Swagger API 文档", Version = "v1", Description = "API 文档"});
// 添加枚举过滤器,在文档中显示枚举的描述信息
c.DocumentFilter<SwaggerEnumFilter>(new object[]
{
// 枚举所在的程序集
new[] {Assembly.GetExecutingAssembly()}
});
c.IncludeXmlComments("Samples.xml");
});
3.引用 Swagger中间件
app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "Samples v1"));
准备工作完成后,可以访问下面的地址,查看生成的 markdown 文档。
https://{localhost}:{port}/doc?swaggerVersion={swaggerVersion}
说明:swaggerVersion 是 swagger 文档版本(AddSwaggerGen 中的 Version 参数,默认 v1)
生成示例
项目地址
https://github.com/liuweichaox/SwaggerDoc