前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >基于 .NET 6.0 Swagger 生成离线文档

基于 .NET 6.0 Swagger 生成离线文档

作者头像
郑子铭
发布2023-09-26 08:17:50
3460
发布2023-09-26 08:17:50
举报
文章被收录于专栏:DotNet NB && CloudNative

SwaggerDoc

SwaggerDoc 是基于 Swashbuckle.AspNetCore 类库的离线文档生工具。文档以 JSON 结构描述参数说明,支持枚举类型描述。工具导出 Markdown 格式文件,可以根据自己需求再将 Markdown 文件转换为自己所需要的文件格式。

如何使用?

  1. 1. 添加 SwaggerDoc引用
代码语言:javascript
复制
dotnet add package SwaggerDoc --version 1.0.1
  1. 2. 注册 SwaggerDoc 服务
代码语言:javascript
复制
services.AddSwaggerDoc(); //(用于MarkDown生成)

注册 Swagger 服务

代码语言:javascript
复制
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中间件

代码语言:javascript
复制
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

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2023-09-25 08:00,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 DotNet NB 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
消息队列 TDMQ
消息队列 TDMQ (Tencent Distributed Message Queue)是腾讯基于 Apache Pulsar 自研的一个云原生消息中间件系列,其中包含兼容Pulsar、RabbitMQ、RocketMQ 等协议的消息队列子产品,得益于其底层计算与存储分离的架构,TDMQ 具备良好的弹性伸缩以及故障恢复能力。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档