个人中心
文章发布
退出
作者热门文章
- ubuntu12.04环境下使用kvm ioctl接口实现最简单的虚拟机
- Ubuntu 通过无线网络安装Ubuntu Server启动系统后连接无线网络的方法
- 在Ubuntu上搭建网桥的方法
- ubuntu 虚拟机上网方式及相关配置详解
32
4
CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.
这篇CFSDN的博客文章Swagger中@ApiIgnore注解的使用详解由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.
@ApiIgnore 可以用在类、方法上，方法参数中，用来屏蔽某些接口或参数，使其不在页面上显示.
|
1
2
3
4
5
6
7
|
@ApiIgnore
@Api
(tags = {
"Xxx控制类"
})
@RestController
@RequestMapping
(
"/xxx"
)
public
class
XxxController {
......
}
|
隐藏某个类还可以用@Api注解自带的hidden属性:
|
1
|
@Api
(value =
"xxx"
, tags =
"xxx"
,hidden =
true
)
|
当hidden为true时，该类隐藏.
|
1
2
3
4
5
6
7
8
9
|
@ApiIgnore
@ApiOperation
(value =
"xxx"
, httpMethod =
"POST"
, notes =
"xxx"
)
@ApiImplicitParams
({
@ApiImplicitParam
(name =
"xxx"
, value =
"xxx"
, paramType =
"query"
, dataType =
"String"
, required =
true
)
})
@PostMapping
(
"/xxx"
)
public
Result importCarryEquExcel(String xxx) {
......
}
|
隐藏某个方法还可以用@APIOperation注解自带的hidden属性:
|
1
|
@ApiOperation
(value =
"xxx"
, httpMethod =
"GET"
, notes =
"xxx"
,hidden =
true
)
|
当hidden为true时，该方法隐藏.
|
1
2
3
|
public
String abc(
@ApiIgnore
String a, String b, String c){
return
"a"
+
"b"
+
"c"
;
}
|
补充:
（1）用@ApiModelProperty注解自带的hidden属性
|
1
2
|
@ApiModelProperty
(value =
"xxxid"
, required =
true
,hidden =
true
)
private
Long id;
|
（2）使用@JsonIgnore注解:
|
1
2
3
|
@ApiModelProperty
(value =
"xxxid"
, required =
true
)
@JsonIgnore
private
Long id;
|
包名:
|
1
|
import
com.fasterxml.jackson.annotation.JsonIgnore;
|
由于架构革新，进入了前后端分离，服务端只需提供RESTful API的时代.
而构建RESTful API会考虑到多终端的问题，这样就需要面对多个开发人员甚至多个开发团队。为了减少与其他团队对接的沟通成本，我们通常会写好对应的API接口文档.
从最早开始的word文档，到后续的showdoc，都能减少很多沟通成本，但随之带来的问题也比较麻烦。在开发期间接口会因业务的变更频繁而变动，如果需要实时更新接口文档，这是一个费时费力的工作.
为了解决上面的问题，Swagger应运而生。他可以轻松的整合进框架，并通过一系列注解生成强大的API文档。他既可以减轻编写文档的工作量，也可以保证文档的实时更新，将维护文档与修改代码融为一体，是目前较好的解决方案.
@Api()用于类； @ApiOperation()用于方法；@ApiParam()用于方法，参数，字段说明； @ApiModel()用于类@ApiModelProperty()用于方法，字段@ApiIgnore()用于类，方法，方法参数@ApiImplicitParam() 用于方法@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
1、@Api 。
|
1
2
3
|
@Api
(value =
"用户博客"
, tags =
"博客接口"
)
public
class
NoticeController {
}
|
2、@ApiOperation 。
|
1
2
3
4
5
6
|
@GetMapping
(
"/detail"
)
@ApiOperation
(value =
"获取用户详细信息"
, notes =
"传入notice"
, position =
2
)
public
R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return
R.data(detail );
}
|
3、@ApiResponses 。
|
1
2
3
4
5
6
7
8
|
@ApiResponses
(value = {
@ApiResponse
(code =
500
, msg=
"INTERNAL_SERVER_ERROR"
, response = R.
class
)})
@GetMapping
(
"/detail"
)
@ApiOperation
(value =
"获取用户详细信息"
, notes =
"传入notice"
, position =
2
)
@ApiResponses
(value = {
@ApiResponse
(code =
500
, msg=
"INTERNAL_SERVER_ERROR"
, response = R.
class
)})
public
R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return
R.data(detail );
}
|
4、@ApiImplicitParams 。
以分页代码进行展示 。
IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class)),
|
1
2
3
4
5
6
7
8
9
10
|
@GetMapping
(
"/list"
)
@ApiImplicitParams
({
@ApiImplicitParam
(name =
"category"
, value =
"公告类型"
, paramType =
"query"
, dataType =
"integer"
),
@ApiImplicitParam
(name =
"title"
, value =
"公告标题"
, paramType =
"query"
, dataType =
"string"
)
})
@ApiOperation
(value =
"分页"
, notes =
"传入notice"
, position =
3
)
public
R<IPage<Notice>> list(
@ApiIgnore
@RequestParam
Map<String, Object> notice, Query query) {
IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.
class
));
return
R.data(pages );
}
|
5、@ApiParam 。
|
1
2
3
4
5
6
|
@PostMapping
(
"/remove"
)
@ApiOperation
(value =
"逻辑删除"
, notes =
"传入notice"
, position =
7
)
public
R remove(
@ApiParam
(value =
"主键集合"
)
@RequestParam
String ids) {
boolean
temp = noticeService.deleteLogic(Func.toIntList(ids));
return
R.status(temp);
}
|
6、@ApiModel 与 @ApiModelProperty 。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
@Data
@ApiModel
(value =
"BladeUser "
, description =
"用户对象"
)
public
class
BladeUser
implements
Serializable {
private
static
final
long
serialVersionUID = 1L;
@ApiModelProperty
(value =
"主键"
, hidden =
true
)
private
Integer userId;
@ApiModelProperty
(value =
"昵称"
)
private
String userName;
@ApiModelProperty
(value =
"账号"
)
private
String account;
@ApiModelProperty
(value =
"角色id"
)
private
String roleId;
@ApiModelProperty
(value =
"角色名"
)
private
String roleName;
}
|
7、@ApiIgnore() 。
|
1
2
3
4
5
6
|
@ApiIgnore
()
@GetMapping
(
"/detail"
)
public
R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return
R.data(detail );
}
|
以上为个人经验，希望能给大家一个参考，也希望大家多多支持我.
原文链接：https://blog.csdn.net/u010250240/article/details/103120635 。
最后此篇关于Swagger中@ApiIgnore注解的使用详解的文章就讲到这里了,如果你想了解更多关于Swagger中@ApiIgnore注解的使用详解的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。
32
4
0
我需要将文本放在 中在一个 Div 中，在另一个 Div 中，在另一个 Div 中。所以这是它的样子: #document Change PIN
奇怪的事情发生了。 我有一个基本的 html 代码。 html，头部， body 。(因为我收到了一些反对票，这里是完整的代码) 这是我的CSS: html { backgroun
我正在尝试将 Assets 中的一组图像加载到 UICollectionview 中存在的 ImageView 中，但每当我运行应用程序时它都会显示错误。而且也没有显示图像。 我在ViewDidLoa
我需要根据带参数的 perl 脚本的输出更改一些环境变量。在 tcsh 中，我可以使用别名命令来评估 perl 脚本的输出。 tcsh: alias setsdk 'eval `/localhome/
我使用 Windows 身份验证创建了一个新的 Blazor(服务器端)应用程序，并使用 IIS Express 运行它。它将显示一条消息“Hello Domain\User!”来自右上方的以下 Ra
这是我的方法 void login(Event event);我想知道 Kotlin 中应该如何 最佳答案 在 Kotlin 中通配符运算符是 * 。它指示编译器它是未知的，但一旦知道，就不会有其他类
看下面的代码 for story in book if story.title.length < 140 - var story
我正在尝试用 C 语言学习字符串处理。我写了一个程序，它存储了一些音乐轨道，并帮助用户检查他/她想到的歌曲是否存在于存储的轨道中。这是通过要求用户输入一串字符来完成的。然后程序使用 strstr()
我正在学习 sscanf 并遇到如下格式字符串: sscanf("%[^:]:%[^*=]%*[*=]%n",a,b,&c); 我理解 %[^:] 部分意味着扫描直到遇到 ':' 并将其分配给 a。:
def char_check(x,y): if (str(x) in y or x.find(y) > -1) or (str(y) in x or y.find(x) > -1):
我有一种情况，我想将文本文件中的现有行包含到一个新 block 中。 line 1 line 2 line in block line 3 line 4 应该变成 line 1 line 2 line
我有一个新项目，我正在尝试设置 Django 调试工具栏。首先，我尝试了快速设置，它只涉及将 'debug_toolbar' 添加到我的已安装应用程序列表中。有了这个，当我转到我的根 URL 时，调试
在 Matlab 中，如果我有一个函数 f，例如签名是 f(a,b,c)，我可以创建一个只有一个变量 b 的函数，它将使用固定的 a=a1 和 c=c1 调用 f: g = @(b) f(a1, b,
我不明白为什么 ForEach 中的元素之间有多余的垂直间距在 VStack 里面在 ScrollView 里面使用 GeometryReader 时渲染自定义水平分隔线。 Scrol
我想知道，是否有关于何时使用 session 和 cookie 的指南或最佳实践？ 什么应该和什么不应该存储在其中？谢谢! 最佳答案 这些文档很好地了解了 session cookie 的安全问题以及
我在 scipy/numpy 中有一个 Nx3 矩阵，我想用它制作一个 3 维条形图，其中 X 轴和 Y 轴由矩阵的第一列和第二列的值、高度确定每个条形的 是矩阵中的第三列，条形的数量由 N 确定。
假设我用两种不同的方式初始化信号量 sem_init(&randomsem,0,1) sem_init(&randomsem,0,0) 现在， sem_wait(&randomsem) 在这两种情况下
我怀疑该值如何存储在“WORD”中，因为 PStr 包含实际输出。？ 既然Pstr中存储的是小写到大写的字母，那么在printf中如何将其给出为“WORD”。有人可以吗？解释一下？ #include
我有一个 3x3 数组: var my_array = [[0,1,2], [3,4,5], [6,7,8]]; 并想获得它的第一个 2
我意识到您可以使用如下方式轻松检查焦点: var hasFocus = true; $(window).blur(function(){ hasFocus = false; }); $(win
我是一名优秀的程序员,十分优秀！