首页 > 其他分享 >Net7中Swagger增加注释

Net7中Swagger增加注释

时间:2023-08-14 15:11:11浏览次数:65  
标签:option 注释 docName version ApiVersions Net7 Swagger string

Swagger增加注释其实很简单

右键项目,属性勾选文档文件即可

 然后代码配置路径:

ApiVersions是版本,可以忽略并写死

services.AddSwaggerGen(option =>
{
    foreach (var version in typeof(ApiVersions).GetEnumNames())
    {
        option.SwaggerDoc(version, new OpenApiInfo()
        {
            Title = !string.IsNullOrWhiteSpace(docName) ? docName : $"Swagger的Api文档",
            Version = version,
            Description = !string.IsNullOrWhiteSpace(docDescription) ? docDescription : $"通用版本的CoreApi版本v1"
        });
    }

    // xml文档绝对路径 
    var file = Path.Combine(AppContext.BaseDirectory, $"{AppDomain.CurrentDomain.FriendlyName}.xml");

    // true : 显示控制器层注释
    option.IncludeXmlComments(file, true);
    // 对action的名称进行排序,如果有多个,就可以看见效果了。
    option.OrderActionsBy(o => o.RelativePath);
});

在UseSwagger中配置下:

 app.UseSwagger();
 app.UseSwaggerUI(option =>
 {
     foreach (string version in typeof(ApiVersions).GetEnumNames())
     {
         option.SwaggerEndpoint($"/swagger/{version}/swagger.json", string.IsNullOrWhiteSpace(docName) ? docName : $"Steven文档【{version}】版本");
     }
 });

这样就可以了

标签:option,注释,docName,version,ApiVersions,Net7,Swagger,string
From: https://www.cnblogs.com/SevenWang/p/17628611.html

相关文章

  • 手摸手3-springboot整合swagger-ui,实现自动文档
    (目录)手摸手3-springboot整合swagger-ui,实现自动文档修改pom.xml<!--解决FluentIterable.class找不到问题--><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>26.0-jre</version>......
  • 关于hive的字段注释乱码解决
    今天我发现我的DBeaver执行完sql后,表的注释乱码,深究下来是要去设置hive的编码,要不注释是乱码。教程:hive设置中文编码格式utf-8_hive建表指定字符集_2021xyz666的博客-CSDN博客......
  • 使用swagger时出现Unable to infer base url. This is common when using dynamic ser
    在使用Swagger的时候访问地址后出现了错误,http://localhost:8001/swagger-ui.html一直在弹窗提示,还取消不了我这边自己的问题可能是因为Swagger类没有跟启动类在同一个模块当中,虽然我将Swagger所在的模块进入到启动类所在的模块,但是可能是idea没有识别到.还是报错,可以按照......
  • Windows 11 自动应答XML注释版
    详细的介绍了Win11自动应答XML各标记的名称、用途:还等什么?访问http://oldhelps.html-5.me,搜索Windows11自动应答XML注释版就是他......
  • 「题解注释」P7518 [省选联考 2021 A/B 卷] 宝石
    联合省选2021宝石题解-hezlik的博客-洛谷博客(luogu.com.cn)耗时:一晚上+半个上午代码注释:#include<bits/stdc++.h>usingnamespacestd;constintN=500000,C=21;intRi(){intx=0,y=1;charc=getchar();for(;c<'0'||c>'9';c=getchar())if......
  • vscode取消json文件注释下划线
    使用vscode打开一个json文件,如果有单行或多行注释,则会显示红色下划线,解决办法如下:方法1点击底部的JSON,选择JSONwithComments即可,然后红色下划线消失,底部显示如下方法2方法1重启vscode可能会失效,因此在设置中搜索files.associations,然后如下图添加项这样就不会失效了!......
  • java_3种注释语句
    1.内容解释//内容单行注释/*内容*/多行注释/***内容*/文档注释2.多行注释与文档注释的区别多行注释:文档注释:JDK提供的工具javadoc解析注释的内容,就是生成了javaAPI文档3.生成步骤4.javadoc标签标签描述示例@author标识......
  • 注释、变量
    python中的注释有2种1、单行注释单行注释用##这是一个单行注释快捷键用Ctrl+/全选多个内容可以多行快速注释,也可以快速去掉注释符#比如 2、多行注释用以三个双引号"""开头,再以3个双引号结尾""""""上面这个是开头2组符号中间的所有位置是多行注释下面这个是结尾"""......
  • 解决vscode行注释快捷键不可用问题
    之前vscode的注释快捷键ctrl+/一直没法使用,查阅了大量资料都是改这个快捷键,但是这个快捷键用习惯了,所以没改,最后靠自己解决了,分享一下。首先在vscode中ctrl+shift+p,输入行注释,点击第一项旁边的齿轮图标。。然后会跳转到它的快捷键,右键,点击显示相同的按键绑定。,然后就会显示冲突......
  • 猫狗笔记注释2
    #coding:utf-8importtensorflowastfimportnumpyasnpimportmatplotlib.pyplotaspltimporttimeimportcreate_and_read_TFRecord2asreader2importosX_train,y_train=reader2.get_file("c:\\cat_and_dog_r")#名为reader2的对象,通过get_file方法来获取指定路径下的......