ApacheCamelREST请求POST的Body参数未在OpenAPI/Swagger文档中显示。
创始人
2024-09-05 14:01:29
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请求体参数。

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...