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

相关内容

热门资讯

分享一款(德扑ai智能)外挂透... 分享一款(德扑ai智能)外挂透明挂辅助器安装(ai代打)发牌规律(2021已更新)(哔哩哔哩);德扑...
透视辅助!雀神广东麻雀机制(辅... 透视辅助!雀神广东麻雀机制(辅助挂)太坑了其实是真的有挂(有挂教程)-哔哩哔哩;雀神广东麻雀机制软件...
透明插件!边锋杭麻圈有外挂,德... 透明插件!边锋杭麻圈有外挂,德扑之星透视软件方法,详细有挂(有挂攻略)-哔哩哔哩;原来确实真的有挂(...
透视透明挂!边锋有辅助挂(we... 透视透明挂!边锋有辅助挂(wePoKe),太坑了果真是真的有挂(有挂规律)-哔哩哔哩;精心打造了俱乐...
玩家必看秘籍(Wepoke透明... 玩家必看秘籍(Wepoke透明)外挂透明挂辅助app(软件)发牌规律(2021已更新)(哔哩哔哩)1...
玩家必看分享!边锋斗地主透明器... 玩家必看分享!边锋斗地主透明器,私人局wepoker脚本,详细有挂(有挂透明)-哔哩哔哩;玩家在边锋...
专业讨论!广东雀神麻雀提升胡牌... 专业讨论!广东雀神麻雀提升胡牌几率(透视)太坑了其实是真的有挂(有挂详情)-哔哩哔哩是一款可以让一直...
一分钟了解!边锋老友二打一有挂... WePoker透视辅助工具核心要点解析‌,一分钟了解!边锋老友二打一有挂,德州传奇辅助最新版更新内容...
技巧知识分享(微扑克原理)外挂... 技巧知识分享(微扑克原理)外挂透明挂辅助挂(外挂)发牌机制(2025已更新)(哔哩哔哩)准备好在微扑...
玩家交流!小程序边锋干瞪眼辅助... 玩家交流!小程序边锋干瞪眼辅助app(wepOkE),太坑了果真是真的有挂(有挂技巧)-哔哩哔哩关于...