个人中心
文章发布
退出
作者热门文章
- Java锁的逻辑（结合对象头和ObjectMonitor）
- 还在用饼状图？来瞧瞧这些炫酷的百分比可视化新图形（附代码实现）⛵
- 自动注册实体类到EntityFrameworkCore上下文，并适配ABP及ABPVNext
- 基于Sklearn机器学习代码实战
25
4
1、前言 现在已经进入了微服务的开发时代了，在这个时代，如果有人问你什么是微服务，你说不知道，就有点太丢人了，别人会有异样的眼光看你，俗话说：唾液淹死人。没办法，我们只能去学习新的东西。一提到微服务，有一个绕不过的话题就是作为微服务的载体，WebAPI是离不开的。但是我们今天不讲WebAPI是什么，如何开发API，以及如何开发Restfull风格的API，我们聊另外一个话题，如何配置Swagger，让其支持多版本，并且支持参数、方法的注释说明。 为什么我们会说这呢，因为，我们要开发API，就会涉及到别人如何使用你的API，相应的使用文档就少不了，当时当我们有了Swagger，就不一样了。Swagger会为我们提供这个文档的功能。 我们今天开发的环境是： 操作系统：Windows 10 Professional 开发工具：Visual Studio 2022 开发语言：C# 开发平台：Asp.Net Core Web API 6.0。 平台类型：跨平台。 2、我们开始配置Swagger，让其支持多版本和注释。 在我们开始配置之前，先有一个直观的感受，我直接上一个截图。 先来第一张截图，概况展示:
再来一张，接口内部详情的:
1、我们先设置一个版本信息的工具类，这个工具类可以放在单独的类库项目中，也可以放在 WebAPI 当前的项目中.
1
///
<summary>
2
///
该类型定义了 WebAPI 版本的信息。
3
///
</summary>
4
public
static
class
ApiVersionInfo
5
{
6
///
<summary>
7
///
初始化默认值。
8
///
</summary>
9
static
ApiVersionInfo()
10
{
11
V1 =
string
.Empty;
12
V2 =
string
.Empty;
13
V3 =
string
.Empty;
14
V4 =
string
.Empty;
15
}
16
17
///
<summary>
18
///
获取或者设置 V1 版本。
19
///
</summary>
20
public
static
string
V1;
21
22
///
<summary>
23
///
获取或者设置 V2 版本。
24
///
</summary>
25
public
static
string
V2;
26
27
///
<summary>
28
///
获取或者设置 V3 版本。
29
///
</summary>
30
public
static
string
V3;
31
32
///
<summary>
33
///
获取或者设置 V4 版本。
34
///
</summary>
35
public
static
string
V4;
36
}
2、我们在 Program 里面配置 Swagger ，具体分为两个部分.
1
using
PatrickLiu.Net6.WebApiDetails.Extensions;
2
using
System.Reflection;
3
4
var
builder =
WebApplication.CreateBuilder(args);
5
6
//
Add services to the container.
7
8
builder.Services.AddControllers();
9
//
Learn more about configuring Swagger/OpenAPI at
https://aka.ms/aspnetcore/swashbuckle
10
builder.Services.AddEndpointsApiExplorer();
11
12
#region
自定义配置Swagger
13
14
builder.Services.AddSwaggerGen(c =>
15
{
16
foreach
(FieldInfo field
in
typeof
(ApiVersionInfo).GetFields())
17
{
18
c.SwaggerDoc(field.Name,
new
Microsoft.OpenApi.Models.OpenApiInfo()
19
{
20
Title = $
"
{field.Name}:这里是 PatrickLiu 教育
"
,
21
Version =
field.Name,
22
Description = $
"
当前的 ASP.Net Core Web API {field.Name} 版本
"
23
});
24
}
25
26
#region
增加api读取注释
27
28
//
获取应用程序所在目录（绝对不受工作目录影响，建议采用此方法获取路径）
29
string
? basePath = Path.GetDirectoryName(
typeof
(Program).Assembly.Location);
30
31
if
(!
string
.IsNullOrEmpty(basePath) && !
string
.IsNullOrWhiteSpace(basePath))
32
{
33
string
xmlPath = Path.Combine(basePath,
"
PatrickLiu.Net6.WebApiDetails.xml
"
);
34
c.IncludeXmlComments(xmlPath);
35
}
36
37
#endregion
38
});
39
40
#endregion
41
42
#region
日志扩展
43
44
//
builder.Logging.AddLog4Net("Config/log4net.config");
45
46
builder.Services.AddLogging(builder =>
47
{
48
builder.AddLog4Net(
"
Config/log4net.config
"
);
49
});
50
51
#endregion
52
53
var
app =
builder.Build();
54
55
#region
Swagger 具体的配置
56
57
app.UseSwagger();
58
app.UseSwaggerUI(c =>
59
{
60
foreach
(FieldInfo field
in
typeof
(ApiVersionInfo).GetFields())
61
{
62
c.SwaggerEndpoint($
"
/swagger/{field.Name}/swagger.json
"
, $
"
{field.Name}
"
);
63
}
64
});
65
66
#endregion
67
68
app.UseAuthorization();
69
70
app.MapControllers();
71
72
app.Run();
3、我们建立我们自己的 APIController ，为每个 Controller 增加 [ApiExplorerSettings(GroupName = nameof(ApiVersionInfo.版本号)) ]，我就创建了2个Controller.
///
<summary>
///
订单的服务控制器。
///
</summary>
[Route(
"
api/[controller]/[action]
"
)]
[ApiController]
[ApiExplorerSettings(GroupName
=
nameof(ApiVersionInfo.V1))]
public
class
OrdersController : ControllerBase
{
///
<summary>
///
获取数据列表。
///
</summary>
///
<returns></returns>
[HttpGet]
[Route(
"
GetAll
"
)]
public
IEnumerable<
string
>
Get()
{
return
new
string
[] {
"
value1
"
,
"
value2
"
};
}
///
<summary>
///
获取主键所对应的数据。
///
</summary>
///
<param name="id">
查询的主键。
</param>
///
<returns></returns>
[HttpGet(
"
{id}
"
)]
public
string
Get(
int
id)
{
return
"
value
"
;
}
///
<summary>
///
增加数据。
///
</summary>
///
<param name="value">
参数
</param>
[HttpPost]
public
void
Post([FromBody]
string
value)
{
}
///
<summary>
///
修改数据。
///
</summary>
///
<param name="id">
查询主键。
</param>
///
<param name="value">
要修改的值。
</param>
[HttpPut(
"
{id}
"
)]
public
void
Put(
int
id, [FromBody]
string
value)
{
}
///
<summary>
///
删除数据。
///
</summary>
///
<param name="id">
要删除的主键。
</param>
[HttpDelete(
"
{id}
"
)]
public
void
Delete(
int
id)
{
}
}
1
///
<summary>
2
///
3
///
</summary>
4
[Route(
"
v2/api/[controller]
"
)]
5
[ApiController]
6
[ApiExplorerSettings(GroupName =
nameof(ApiVersionInfo.V2))]
7
public
class
OrdersV2Controller : ControllerBase
8
{
9
///
<summary>
10
///
获取数据列表。
11
///
</summary>
12
///
<returns></returns>
13
[HttpGet]
14
public
IEnumerable<
string
>
Get()
15
{
16
return
new
string
[] {
"
value1
"
,
"
value2
"
};
17
}
18
19
///
<summary>
20
///
获取主键所对应的数据。
21
///
</summary>
22
///
<param name="id">
查询的主键。
</param>
23
///
<returns></returns>
24
[HttpGet(
"
{id}
"
)]
25
public
string
Get(
int
id)
26
{
27
return
"
value
"
;
28
}
29
30
///
<summary>
31
///
增加数据。
32
///
</summary>
33
///
<param name="value">
参数
</param>
34
[HttpPost]
35
public
void
Post([FromBody]
string
value)
36
{
37
}
38
39
///
<summary>
40
///
修改数据。
41
///
</summary>
42
///
<param name="id">
查询主键。
</param>
43
///
<param name="value">
要修改的值。
</param>
44
[HttpPut(
"
{id}
"
)]
45
public
void
Put(
int
id, [FromBody]
string
value)
46
{
47
}
48
49
///
<summary>
50
///
删除数据。
51
///
</summary>
52
///
<param name="id">
要删除的主键。
</param>
53
[HttpDelete(
"
{id}
"
)]
54
public
void
Delete(
int
id)
55
{
56
}
57
58
///
<summary>
59
///
增加一个人。
60
///
</summary>
61
///
<param name="person">
要增加的人
</param>
62
///
<param name="id">
主键值。
</param>
63
///
<param name="name">
姓名。
</param>
64
///
<param name="sex">
性别
</param>
65
///
<param name="address">
地址。
</param>
66
[HttpPost]
67
[Route(
"
PutData
"
)]
68
public
void
PutData(SinglePerson person,
int
id,
string
name,
bool
sex,
string
address)
69
{
70
71
}
72
}
4、运行起来，看看效果吧.
。
3、结束语 当我们的WebAPI有了新版本，我们也不用怕了，只要按我的设置，就可以灵活应付。不负苍天，继续努力.
最后此篇关于如何在Net6.0里配置多版本支持并支持注释说明的Swagger的文章就讲到这里了,如果你想了解更多关于如何在Net6.0里配置多版本支持并支持注释说明的Swagger的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。
25
4
0
我的 processmaker 安装遇到了一些问题。我正在尝试使用本指南 [url]http://wiki.processmaker.com/index.php/ProcessMaker_Ubuntu
我正在使用 ShareKit。发送 SMS 消息使用 MFMessageComposeViewController，用户看到标题“文本”。我想将该标题更改为更能反射(reflect)实际可用内容的内容
我需要在我的一个针对 Gingerbread 的 Android 应用程序中使用操作栏和 fragment 的组合。所以我使用了 v7 支持库中的操作栏和 v4 支持库中的 fragment ，并使用
我明白为什么浏览器 vendor 不想帮助我阻止他们的 UI 线程。但是，我不明白为什么会有: Web Workers 中没有 sleep (2) 没有同步 WebSockets API 有一个syn
最近我的组织正在考虑使用 Docker。我们组使用的是cloudera CDH 5.1.2。 1) cloudera 是否与 Docker 容器兼容？2) docker 和cloudera 组合是否存
我正在尝试通过编译在 Mac 上安装 rsync 3.2.3。但是，我想安装所有功能。为此，它需要一些库，此处 ( https://download.samba.org/pub/rsync/INSTA
我一直在使用 PyDev 成功运行 nose 测试，并想试试 nose2。 所以我安装了它 pip install nose2 复制/粘贴来自 http://nose2.info/ 的示例代码进入名为
我想知道 LLVM 中是否有任何函数/方法可以在 LLVM IR 中添加 Open-MP 构造。 llvm-3.0 是否仍然支持 OpenMP 指令？ 最佳答案 OpenMP 是一种高级语言扩展。因此
我对 CUDA 编程非常陌生。我正在浏览 SDK 附带的示例。我能够编译代码，但是当我运行它时，出现以下错误: "clock.cu(177) : CUDA Runtime API error 38:
RStudio 是用于 R 开发的出色 IDE。我想知道是否有任何方法可以很好地支持 HiDPI 分辨率？ 我目前有 13 英寸显示器和 3200x1800 分辨率，甚至很难阅读 RStudio 选项
我正在寻找一种有助于为 Django 项目提供 RDF 支持的工具。 到目前为止，我发现了两个: django-rdf - 最后一次修改是在 4 年前，所以它看起来像是一个死项目。 djubby -
我刚刚尝试了一些 JS 核心原则，发现引擎评估链接的关系运算符而不会引发错误。相反，他们以我自己无法理解的方式进行评估。 console.log(1 4 > 3 > 2 > 1); //false,
我知道 etexteditor 和 vim/emacs。 是否有任何其他 Windows 编辑器支持类似 textmate 的片段(例如，您编写触发词，按 Tab，它更改为某些内容，再次按 Tab，它
我正在尝试找出验证给定集群的网络策略配置的最佳方法。 According to the documentation Network policies are implemented by the ne
很难说出这里问的是什么。这个问题是含糊的、模糊的、不完整的、过于宽泛的或修辞性的，无法以目前的形式得到合理的回答。如需帮助澄清此问题以便重新打开它，visit the help center 。 已关
Z3 会支持 AUFBV 吗？ 对于以下脚本: (set-logic AUFBV) (declare-fun x () (_ BitVec 16)) (declare-const t (Array (
使用分部类编写 NUnit 测试的优缺点是什么？ 我要开始了: 亲:可以测试私有(private)方法 缺点:TDD 不再可能了 还有什么？ 最佳答案 缺点:要么您必须测试与您发布的版本不同的构建，要
它很容易(对于 90% 的 aop 特性)在没有任何语言本身支持的情况下做到这一点，就像大多数动态语言如 python 和 ruby 一样。然而，Dojo在 1.3.2 上直接支持它.最新版本发生
我在我的 android 应用程序中使用亚洲字符，我已经了解到某些字符无法显示，因为系统字体不支持它们。我查询了一个包含亚洲字符的数据库，并且经常检索到无法显示的标志。这些情况对我的应用程序来说通常不
你好，我想实现一个控件，我想在用户键入@字符时启用该控件，直到未填充运行文本中的空格为止，它应该显示用户列表，@符号后键入的文本应该显示基于键盘字符的建议，就像我们在上面看到的那样Twitter 或
我是一名优秀的程序员,十分优秀！