基于 .NET 6.0 Swagger 生成离线文档
原文中文，约1200字，阅读约需3分钟。
📝
内容提要
SwaggerDoc是一个基于Swashbuckle.AspNetCore类库的离线文档生成工具，支持以JSON结构描述参数说明和枚举类型描述。使用方法包括添加SwaggerDoc引用、注册SwaggerDoc服务和Swagger服务、引用Swagger中间件等。生成的Markdown格式文件可以根据需要转换为其他格式。
🎯
关键要点
-
SwaggerDoc是基于Swashbuckle.AspNetCore类库的离线文档生成工具。
-
文档以JSON结构描述参数说明，支持枚举类型描述。
-
工具导出Markdown格式文件，可以根据需求转换为其他格式。
-
使用方法包括添加SwaggerDoc引用、注册SwaggerDoc服务和Swagger服务、引用Swagger中间件等。
-
添加SwaggerDoc引用的命令为：dotnet add package SwaggerDoc --version 1.0.1。
-
注册SwaggerDoc服务的代码示例：services.AddSwaggerDoc();。
-
注册Swagger服务的代码示例包括添加枚举过滤器和XML注释。
-
引用Swagger中间件的代码示例：app.UseSwagger();和app.UseSwaggerUI();。
-
生成的Markdown文档可以通过特定地址访问，格式为：https://{localhost}:{port}/doc?swaggerVersion={swaggerVersion}。
-
项目地址为：https://github.com/liuweichaox/SwaggerDoc。
🏷️
