ApacheCamelREST请求POST的Body参数未在OpenAPI/Swagger文档中显示。
创始人
2024-09-05 14:01:05
0

可以使用Camel OpenAPI插件来生成OpenAPI规范文档并将其公开到Swagger UI中。为了在OpenAPI文档中显示POST请求的Body参数,需要将Camel OpenAPI插件配置为支持请求体参数。

以下是使用Camel OpenAPI插件和Camel Rest DSL定义REST服务的示例代码:

restConfiguration()
	.component("servlet")
	.bindingMode(RestBindingMode.auto)
	.dataFormatProperty("prettyPrint", "true")
	.contextPath("/api")
	.apiContextPath("/api-doc")
	.apiProperty("api.title", "User API")
	.apiProperty("cors", "true")
	.enableCORS(true)
	.port(8080)
	.host("localhost");

rest("/users").description("User REST service")
	.produces("application/json")
	.consumes("application/json")
	
	.post().description("Add a new user")
		.type(User.class)
		.param().name("body").type(body).description("The user to add").endParam()
		.outType(User.class)
		.route()
		    .to("bean:UserService?method=addUser")
		.endRest();

在POST请求中,我们使用了.type(User.class)定义请求体参数的类型,并使用.param()定义请求体参数。使用.outType(User.class)定义响应体参数的类型。

要在OpenAPI文档中显示请求体参数,需要使用.apiParam()定义OpenAPI参数。以下是示例代码:

.post().description("Add a new user")
	.type(User.class)
	.param().name("body").type(body).description("The user to add")
		.apiParam().name("user").type(User.class).description("User object").endParam()
	.endParam()
	.outType(User.class)
	.route()
		.to("bean:UserService?method=addUser")
	.endRest();

您应该能够在OpenAPI文档中看到相应的POST请求体参数。

相关内容

热门资讯

总算了解!打哈儿辅助软件,we... 总算了解!打哈儿辅助软件,wepoker手机版透视脚本,可靠技巧(有挂工具)是一款可以让一直输的玩家...
分辨真假!闲聚鱼虾蟹软件脚本,... 分辨真假!闲聚鱼虾蟹软件脚本,聚星ai辅助工具下载,靠谱教程(真实有挂)是一款可以让一直输的玩家,快...
实操分享!牵手跑得软件,wep... 实操分享!牵手跑得软件,wepoker高级辅助,详细教程(有挂方略);相信小伙伴都知道这个牵手跑得软...
揭秘关于!人海大厅挂什么好,w... 揭秘关于!人海大厅挂什么好,we poker辅助器v3.3,揭秘攻略(详细教程);1、点击下载安装,...
科技新动态!乐酷大厅怎么安装,... 您好,乐酷大厅怎么安装这款游戏可以开挂的,确实是有挂的,需要了解加微【136704302】很多玩家在...
一分钟揭秘!胡乐辅助脚本是真的... 一分钟揭秘!胡乐辅助脚本是真的假的,wpk有作弊吗,安装教程(有挂助手)是一款可以让一直输的玩家,快...
热点推荐!皮皮游戏辅助平台,w... 【福星临门,好运相随】;热点推荐!皮皮游戏辅助平台,wepoker破解游戏盒子,技巧教程(有挂分享)...
交流学习经验!家乡大贰辅助,p... 交流学习经验!家乡大贰辅助,pokerworld辅助器,可靠技巧(有挂技巧);小薇(透视辅助)致您一...
我来教大家!瑞安玉海楼茶苑辅助... 我来教大家!瑞安玉海楼茶苑辅助器,hhpoker怎么开透视,2025新版技巧(真是有挂);最新版20...
我来向大家传授!卡五星辅助器,... 我来向大家传授!卡五星辅助器,wepoker透视脚本免费app,必胜教程(有挂详细);1、点击下载安...