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请求体参数。

相关内容

热门资讯

分享实测,wpk俱乐部有挂吗,... 您好,wpk俱乐部有挂吗这款游戏可以开挂的,确实是有挂的,需要了解加微【485275054】很多玩家...
AI教程,德扑智能辅助软件,A... AI教程,德扑智能辅助软件,AApoker透视挂件总结(原先是真的有辅助挂)AI 是一款可以让一直输...
重大通报!,wepoker透视... 您好:wepoker透视作弊挂这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多...
推荐几款新版,微扑克辅助封号,... 本地部署 AI 黑科技工具迎来新版本,不用上传文件到云端就能完成微扑克辅助封号解析、 AI 处理、微...
每日必看教程,德州辅助器免费下... 您好,每日必看教程,德州辅助器免费下载最新版本,AApoker是不是有挂攻略(从来真的是有辅助器)这...
记者发布,德州wpk透视辅助器... 记者发布,德州wpk透视辅助器,德扑之星透视软件教程书(最初真的是有辅助)是一款可以让一直输的玩家,...
分享开挂内幕,wepokerp... 您好,wepokerplus挂先试用后付款这款游戏可以开挂的,确实是有挂的,需要了解加微【48527...
存在挂教程,wepoker辅助... 存在挂教程,wepoker辅助器教程,智星菠萝德州可以开挂吗教材(从来真的是有透视挂)是一款可以让一...
每日必看,德扑之星透视挂,WO... 每日必看,德扑之星透视挂,WOK透视挂模板(果然是有辅助挂)是一款可以让一直输的玩家,快速成为一个“...
热点讨论,德扑之星破解透视挂,... 热点讨论,德扑之星破解透视挂,WePoKer开挂工具手筋(原来真的有辅助器)是一款可以让一直输的玩家...