个人中心
文章发布
退出
作者热门文章
- Java锁的逻辑（结合对象头和ObjectMonitor）
- 还在用饼状图？来瞧瞧这些炫酷的百分比可视化新图形（附代码实现）⛵
- 自动注册实体类到EntityFrameworkCore上下文，并适配ABP及ABPVNext
- 基于Sklearn机器学习代码实战
37
4
周末，写点简单的水一下.
新版本的vs创建项目的时候可以选择自带一个swagger。然而这只是基本的swagger功能.
几个接口无所谓啦，随着接口越来越多，就这么丢给你，一时间也会懵逼，所以这篇文章要做的有两个功能.
右键项目>属性>生成>输出>XML文档文件路径，添加输出的路径，我一般会设置在程序集下的根路径，例如这样:
文件命名什么的随意，一般跟项目有关例如：FastEasy.Readme.xml.
然后去swagger相关的Module模块中去添加一些配置。我这个文章相关的项目一开始的时候就将这些注入配置单独搞成独立的一个模块，所以你只是看到这个文章，那默认就在Programs里面找AddSwaggerGen就好.
Services.AddSwaggerGen(s =>
{
//
多版本
typeof
(SwaggerVersion).GetEnumNames().ToList().ForEach(v =>
{
s.SwaggerDoc(v,
new
Microsoft.OpenApi.Models.OpenApiInfo
{
Version
=
v,
Description
= $
"
{v} API
"
,
Title
=
v,
});
//
添加注释
var
basePath=
AppDomain.CurrentDomain.BaseDirectory;
var
xmlPath = Path.Combine(basePath,
"
FastEasy.Readme.xml
"
);
s.IncludeXmlComments(xmlPath,
true
);
});
});
。
。
如果不需要切换版本，那就关注添加注释下面三行代码就好，获取注释文档的路径，然后添加到swagger中.
接下来就是多版本切换，上面的代码已经是了，需要在意的地方是typeof里的SwaggerVersion。这是创建的一个枚举，然后在枚举中按需添加不同的版本切换，例如 。
public
enum
SwaggerVersion
{
FastEasy
=
1
,
OpenAPI
=
2
}
。
如果要使用多版本，中间件管道里也要改一下 。
app.UseSwagger();
app.UseSwaggerUI(s
=>
{
typeof
(SwaggerVersion).GetEnumNames().ToList().ForEach(v =>
{
s.SwaggerEndpoint($
"
swagger/{v}/swagger.json
"
, $
"
{v}
"
);
s.RoutePrefix
=
string
.Empty;
});
});
。
到这里就已经完成90%了。最后一步就是给不同的方法或者控制器添加[ApiExplorerSettings(GroupName = "OpenAPI")] 。
[HttpGet(
"
MUL
"
)]
[ApiExplorerSettings(GroupName
=
"
OpenAPI
"
)]
public
int
MUL(
int
i,
int
j)
{
return
test.MUL(i, j);
}
。
原本是加减乘除4个接口，现在就是FastEasy下两个，OpenAPI下两个(只是测试，跟名称毫无关系) 。
现在完成了99%了。如果像我这种小公司，没有版本的区别，无非就是为了看着方便，因为功能模块去区分开来。就像现在，查看文档的时候可以根据分类找到相对应的接口，不至于一眼乱糟糟的.
但是实际上并未完成版本控制，因为你会发现，他们的请求路径是差不多的。如果要完成真正的版本控制，有两种方法，第一种简单，路由上写死了：/v1/xxxx /v2/xxxxx…… 。
第二种就是自定义路由特性：添加一个特性配置的类:SwaagerRouteAttribute。我直接贴代码了，很简单的几行，代码的注释足以解释清楚了 。
public
class
SwaagerRouteAttribute : RouteAttribute, IApiDescriptionGroupNameProvider
{
///
<summary>
///
默认的路由配置
///
</summary>
///
<param name="actionName"></param>
public
SwaagerRouteAttribute(
string
actionName) :
base
(actionName)
{
}
///
<summary>
///
分组名称,控制不同版本:等同于配置ApiExplorerSettings(GroupName ="FastEasy")
///
</summary>
public
string
? GroupName {
get
;
set
; }
///
<summary>
///
自定义的路由配置
///
</summary>
///
<param name="version"></param>
///
<param name="actionName"></param>
public
SwaagerRouteAttribute(SwaggerVersion version,
string
actionName =
"
[action]
"
) :
base
($
"
/{version.ToString()}/[controller]/{actionName}
"
)
{
GroupName
=
version.ToString();
}
}
。
现在！用自己封装的路由属性添加到方法上面(截图看的全) 。
。
此时才算完成真的版本控制效果:
啊掰掰~ 。
。
最后此篇关于6.swagger完善：界面显示注释+多版本控制的文章就讲到这里了,如果你想了解更多关于6.swagger完善：界面显示注释+多版本控制的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。
37
4
0
无法使用 Hive 版本 1.1.0 HBase 版本 0.94.8 和 hadoop 版本 2.7.0 从 hive 创建 Hbase 表 hive (default)> CREATE TABLE
我试图为 electron app 创建可执行文件但面临这个问题 Unable to determine Electron version. Please specify an Electron ve
我正在尝试让自适应阈值在 python 绑定(bind)到 opencv 中工作(swig 一个 - 无法让 opencv 2.0 工作，因为我正在使用 beagleboard 因为交叉编译还没有工作
我一直在 linux 机器上使用 JMeter，在命令行下使用了一段时间。工作正常。 今天，我在 Windows 机器(新客户端等)上尝试了它，它确实可以工作，但在控制台窗口中输出有很大不同。 Lin
在我的编码环境中，我通常使用最新版本的 Java 和 Eclipse。当我编写源代码时，我不会注意我使用的 API 方法或类是否向后兼容旧版本的 Java 或 Eclipse。在 javadoc 中存
问题是关于版本的特定组合，但更普遍。 我刚刚从 Kubuntu 12.04 升级到 14.04。现在，当我想编译 CUDA 代码(使用 CUDA 6.5)时，我得到: #error -- unsupp
我目前正在对我的一些应用程序进行沙箱处理，看来我必须删除一些功能才能满足 Mac App Store 沙箱(和其他)规则。 显然用户不会因为失去功能而感到高兴，我担心他们不会指责苹果制定了愚蠢的规则，
我用 flash 和 js 版本创建了一个动画横幅。 是否可以检测低于版本 9 的 ie 版本，然后提供 Flash 横幅，否则提供 js 横幅。 最佳答案 您可以使用条件注释来检测 IE 版本
我有一个处理不同位置的数据库的应用程序，我想检查这些数据库是否使用 Firebird 2.5 或更高版本打开。我们最近从 Firebird 2.0 迁移到了 2.5，我们有很多数据库可以响应 sele
我正在开发一个应用程序，我使用托管在我的服务器上的 Java 和 Jersey 构建了后端部分。我在服务器上使用 Tomcat7 来调用 Web 服务。 我以前有一台安装了 Ubuntu 的计算机，我
我可以使用 GetVersionEx() 函数来获取 Windows 版本，但是这个函数将返回一个数字而不是一个字符串。但是没有问题，因为我可以将数字转换为字符串，例如: if (osvi.dwMaj
我已经在我的系统中安装了 Anaconda 2 & 3。 Anaconda 2 包含 python 2.7 & Anaconda 3 包含 python 3.6。 我需要使用命令提示符运行我的 pyt
我正在尝试构建一个 Android 项目，但发生了以下错误 Error:(10, 1) A problem occurred evaluating project ':app'. > Failed t
关闭。这个问题需要更多focused .它目前不接受答案。 想改进这个问题吗？ 更新问题，使其只关注一个问题 editing this post . 关闭 4 年前。 Improve this qu
在降级我的 GCC 之前，我想知道是否有办法确定我的机器中的哪些程序/框架或依赖项会中断，以及是否有更好的方法来执行 openpose 安装？ (例如，在 CMake 中更改某些内容) 有没有办法在不
我已经在终端的代码sudo apt-get install Shadowsocks-qt5中安装了Shadowsocks-Qt5，然后我可以通过搜索找到启动图标，但是它当我点击图标时打不开。然后我尝试
在网络上找到的文档说，MLLP V2(第 2 版)是用于传输 HL7 版本 3 内容的所有消息传输协议(protocol)的要求。似乎 MLLP 第 2 版主要用于 HL7 第 3 版。 我们可以/应
我正在使用带有 selinium webdriver 的 Protractor 。我的chromeDriver版本是78.0.1，chrome版本是78.0.3904.97。两个版本都匹配，应该不会有
我正在按照教程设置 mysql 数据库并做一些事情。我无法找到数据库资源管理器。我读了很多，但在 Window->show View-> Dataxxx 或右侧上部选项卡中无法正常工作。 最佳答案 从
我已经在 KDE 桌面上安装了 Anaconda 2.0.1。当我运行 python 并看到所有已安装的模块时，我收到此消息“无法将不兼容的 Qt 库(版本 0x40801)与该库(版本 0x4080
我是一名优秀的程序员,十分优秀！